PlayerEntity Class Reference

#include <PlayerEntity.h>

Inheritance diagram for PlayerEntity:

Collaboration diagram for PlayerEntity:

Instance Methods
(void)	- deferredInit
(BOOL)	- setUpAndConfirmOK:
(BOOL)	- setUpAndConfirmOK:saveGame:
(void)	- completeSetUp
(void)	- completeSetUpAndSetTarget:
(void)	- startUpComplete
(NSString *)	- commanderName
(void)	- setCommanderName:
(NSString *)	- lastsaveName
(void)	- setLastsaveName:
(BOOL)	- isDocked
(void)	- warnAboutHostiles
(void)	- unloadCargoPods
(void)	- loadCargoPods
(void)	- unloadAllCargoPodsForType:toManifest:
(void)	- unloadCargoPodsForType:amount:
(void)	- loadCargoPodsForType:fromManifest:
(void)	- loadCargoPodsForType:amount:
(OOCommodityMarket *)	- shipCommodityData
(OOCreditsQuantity)	- deciCredits
(int)	- random_factor
(void)	- setRandom_factor:
(OOGalaxyID)	- galaxyNumber
(NSPoint)	- galaxy_coordinates
(void)	- setGalaxyCoordinates:
(void)	- setCustomChartCentre:
(NSPoint)	- cursor_coordinates
(NSPoint)	- chart_centre_coordinates
(NSPoint)	- custom_chart_centre_coordinates
(OOScalar)	- chart_zoom
(OOScalar)	- custom_chart_zoom
(void)	- setCustomChartZoom:
(NSPoint)	- adjusted_chart_centre
(OORouteType)	- ANAMode
(NSString *)	- jumpCause
(void)	- setJumpCause:
(OOSystemID)	- systemID
(void)	- setSystemID:
(OOSystemID)	- targetSystemID
(void)	- setTargetSystemID:
(OOSystemID)	- previousSystemID
(void)	- setPreviousSystemID:
(OOSystemID)	- nextHopTargetSystemID
(OOSystemID)	- infoSystemID
(void)	- setInfoSystemID:moveChart:
(void)	- nextInfoSystem
(void)	- previousInfoSystem
(void)	- homeInfoSystem
(void)	- targetInfoSystem
(BOOL)	- infoSystemOnRoute
(NSDictionary *)	- commanderDataDictionary
(BOOL)	- setCommanderDataFromDictionary:
(void)	- addEquipmentWithScriptToCustomKeyArray:
(void)	- validateCustomEquipActivationArray
(void)	- doBookkeeping:
(BOOL)	- isValidTarget:
(void)	- setMassLockable:
(BOOL)	- massLockable
(BOOL)	- massLocked
(BOOL)	- atHyperspeed
(float)	- occlusionLevel
(void)	- setOcclusionLevel:
(void)	- setDockedAtMainStation
(StationEntity *)	- dockedStation
(void)	- setDockedStation:
(void)	- performDockingRequest:
(void)	- requestDockingClearance:
(void)	- cancelDockingRequest:
(BOOL)	- engageAutopilotToStation:
(void)	- disengageAutopilot
(void)	- resetAutopilotAI
(void)	- setTargetDockStationTo:
(StationEntity *)	- getTargetDockStation
(HeadUpDisplay *)	- hud
(BOOL)	- switchHudTo:
(void)	- resetHud
(float)	- dialCustomFloat:
(NSString *)	- dialCustomString:
(OOColor *)	- dialCustomColor:
(void)	- setDialCustom:forKey:
(NSArray *)	- multiFunctionDisplayList
(NSString *)	- multiFunctionText:
(void)	- setMultiFunctionText:forKey:
(BOOL)	- setMultiFunctionDisplay:toKey:
(void)	- cycleNextMultiFunctionDisplay:
(void)	- cyclePreviousMultiFunctionDisplay:
(void)	- selectNextMultiFunctionDisplay
(void)	- selectPreviousMultiFunctionDisplay
(NSUInteger)	- activeMFD
(void)	- setShowDemoShips:
(BOOL)	- showDemoShips
(GLfloat)	- forwardShieldLevel
(GLfloat)	- aftShieldLevel
(GLfloat)	- baseMass
(void)	- setForwardShieldLevel:
(void)	- setAftShieldLevel:
(float)	- forwardShieldRechargeRate
(float)	- aftShieldRechargeRate
(void)	- setMaxForwardShieldLevel:
(void)	- setMaxAftShieldLevel:
(void)	- setForwardShieldRechargeRate:
(void)	- setAftShieldRechargeRate:
(NSDictionary *)	- keyConfig
(BOOL)	- isMouseControlOn
(GLfloat)	- dialRoll
(GLfloat)	- dialPitch
(GLfloat)	- dialYaw
(GLfloat)	- dialSpeed
(GLfloat)	- dialHyperSpeed
(void)	- currentWeaponStats
(GLfloat)	- dialForwardShield
(GLfloat)	- dialAftShield
(GLfloat)	- dialEnergy
(GLfloat)	- dialMaxEnergy
(GLfloat)	- dialFuel
(GLfloat)	- dialHyperRange
(GLfloat)	- dialAltitude
(unsigned)	- countMissiles
(OOMissileStatus)	- dialMissileStatus
(OOFuelScoopStatus)	- dialFuelScoopStatus
(float)	- fuelLeakRate
(void)	- setFuelLeakRate:
(GLfloat)	- hyperspeedFactor
(BOOL)	- injectorsEngaged
(BOOL)	- hyperspeedEngaged
(NSMutableArray *)	- customEquipmentActivation
(double)	- clockTime
(double)	- clockTimeAdjusted
(BOOL)	- clockAdjusting
(void)	- addToAdjustTime:
(double)	- escapePodRescueTime
(void)	- setEscapePodRescueTime:
(NSString *)	- dial_clock
(NSString *)	- dial_clock_adjusted
(NSString *)	- dial_fpsinfo
(NSString *)	- dial_objinfo
(NSMutableArray *)	- commLog
(Entity *)	- compassTarget
(void)	- setCompassTarget:
(void)	- validateCompassTarget
(NSString *)	- compassTargetLabel
(OOCompassMode)	- compassMode
(void)	- setCompassMode:
(void)	- setPrevCompassMode
(void)	- setNextCompassMode
(NSUInteger)	- activeMissile
(void)	- setActiveMissile:
(NSUInteger)	- dialMaxMissiles
(BOOL)	- dialIdentEngaged
(void)	- setDialIdentEngaged:
(NSString *)	- specialCargo
(NSString *)	- dialTargetName
(ShipEntity *)	- missileForPylon:
(void)	- safeAllMissiles
(void)	- selectNextMissile
(void)	- tidyMissilePylons
(BOOL)	- removeFromPylon:
(BOOL)	- assignToActivePylon:
(void)	- clearAlertFlags
(int)	- alertFlags
(void)	- setAlertFlag:to:
(OOAlertCondition)	- alertCondition
(OOPlayerFleeingStatus)	- fleeingStatus
(BOOL)	- mountMissile:
(BOOL)	- mountMissileWithRole:
(OOEnergyUnitType)	- installedEnergyUnitType
(OOEnergyUnitType)	- energyUnitType
(ShipEntity *)	- launchMine:
(BOOL)	- activateCloakingDevice
(void)	- deactivateCloakingDevice
(double)	- scannerFuzziness
(BOOL)	- weaponsOnline
(void)	- setWeaponsOnline:
(BOOL)	- fireMainWeapon
(OOWeaponType)	- weaponForFacing:
(OOWeaponType)	- currentWeapon
(NSArray *)	- currentLaserOffset
(void)	- rotateCargo
(BOOL)	- hasSufficientFuelForJump
(BOOL)	- witchJumpChecklist:
(void)	- enterGalacticWitchspace
(void)	- setJumpType:
(BOOL)	- takeInternalDamage
(BOOL)	- endScenario:
(NSMutableArray *)	- roleWeights
(void)	- addRoleForAggression:
(void)	- addRoleForMining
(void)	- addRoleToPlayer:
(void)	- addRoleToPlayer:inSlot:
(void)	- clearRoleFromPlayer:
(void)	- clearRolesFromPlayer:
(NSUInteger)	- maxPlayerRoles
(void)	- updateSystemMemory
(void)	- loseTargetStatus
(void)	- docked
(void)	- setGuiToStatusScreen
(NSArray *)	- equipmentList
(BOOL)	- setPrimedEquipment:showMessage:
(NSString *)	- primedEquipmentName:
(NSString *)	- currentPrimedEquipment
(NSUInteger)	- primedEquipmentCount
(void)	- activatePrimableEquipment:withMode:
(NSString *)	- fastEquipmentA
(NSString *)	- fastEquipmentB
(void)	- setFastEquipmentA:
(void)	- setFastEquipmentB:
(OOCreditsQuantity)	- adjustPriceByScriptForEqKey:withCurrent:
(NSArray *)	- cargoList
(unsigned)	- legalStatusOfCargoList
(void)	- setGuiToSystemDataScreen
(void)	- setGuiToSystemDataScreenRefreshBackground:
(NSDictionary *)	- markedDestinations
(void)	- setGuiToLongRangeChartScreen
(void)	- setGuiToShortRangeChartScreen
(void)	- setGuiToChartScreenFrom:
(void)	- setGuiToLoadSaveScreen
(void)	- setGuiToGameOptionsScreen
(OOWeaponFacingSet)	- availableFacings
(void)	- setGuiToEquipShipScreen:selectingFacingFor:
(void)	- setGuiToEquipShipScreen:
(void)	- setGuiToInterfacesScreen:
(void)	- showInformationForSelectedInterface
(void)	- activateSelectedInterface
(void)	- highlightEquipShipScreenKey:
(void)	- showInformationForSelectedUpgrade
(void)	- showInformationForSelectedUpgradeWithFormatString:
(BOOL)	- setWeaponMount:toWeapon:
(BOOL)	- setWeaponMount:toWeapon:inContext:
(BOOL)	- changePassengerBerths:
(OOCargoQuantity)	- cargoQuantityForType:
(OOCargoQuantity)	- setCargoQuantityForType:amount:
(void)	- calculateCurrentCargo
(void)	- setGuiToMarketScreen
(void)	- setGuiToMarketInfoScreen
(NSArray *)	- applyMarketFilter:onMarket:
(NSArray *)	- applyMarketSorter:onMarket:
(OOCommodityMarket *)	- localMarket
(void)	- setupStartScreenGui
(void)	- setGuiToIntroFirstGo:
(void)	- setGuiToOXZManager
(void)	- noteGUIWillChangeTo:
(void)	- noteGUIDidChangeFrom:to:refresh:
(void)	- noteGUIDidChangeFrom:to:
(void)	- noteViewDidChangeFrom:toView:
(OOGUIScreenID)	- guiScreen
(void)	- buySelectedItem
(BOOL)	- tryBuyingCommodity:all:
(BOOL)	- trySellingCommodity:all:
(OOSpeechSettings)	- isSpeechOn
(void)	- addEquipmentFromCollection:
(void)	- getFined
(void)	- adjustTradeInFactorBy:
(int)	- tradeInFactor
(double)	- renovationCosts
(double)	- renovationFactor
(void)	- setDefaultViewOffsets
(void)	- setDefaultCustomViews
(Vector)	- weaponViewOffset
(void)	- setUpTrumbles
(void)	- addTrumble:
(void)	- removeTrumble:
(OOTrumble **)	- trumbleArray
(NSUInteger)	- trumbleCount
(id)	- trumbleValue
(void)	- setTrumbleValueFrom:
(float)	- trumbleAppetiteAccumulator
(void)	- setTrumbleAppetiteAccumulator:
(void)	- mungChecksumWithNSString:
(NSString *)	- screenModeStringForWidth:height:refreshRate:
(void)	- suppressTargetLost
(void)	- setScoopsActive
(void)	- clearTargetMemory
(NSMutableArray *)	- targetMemory
(BOOL)	- moveTargetMemoryBy:
(void)	- printIdentLockedOnForMissile:
(void)	- applyYaw:
(Quaternion)	- customViewQuaternion
(void)	- setCustomViewQuaternion:
(OOMatrix)	- customViewMatrix
(Vector)	- customViewOffset
(void)	- setCustomViewOffset:
(Vector)	- customViewRotationCenter
(void)	- setCustomViewRotationCenter:
(void)	- customViewZoomOut:
(void)	- customViewZoomIn:
(void)	- customViewRotateLeft:
(void)	- customViewRotateRight:
(void)	- customViewRotateUp:
(void)	- customViewRotateDown:
(void)	- customViewRollLeft:
(void)	- customViewRollRight:
(void)	- customViewPanUp:
(void)	- customViewPanDown:
(void)	- customViewPanLeft:
(void)	- customViewPanRight:
(Vector)	- customViewForwardVector
(Vector)	- customViewUpVector
(Vector)	- customViewRightVector
(NSString *)	- customViewDescription
(void)	- resetCustomView
(void)	- setCustomViewData
(void)	- setCustomViewDataFromDictionary:withScaling:
(HPVector)	- viewpointPosition
(HPVector)	- breakPatternPosition
(Vector)	- viewpointOffset
(Vector)	- viewpointOffsetAft
(Vector)	- viewpointOffsetForward
(Vector)	- viewpointOffsetPort
(Vector)	- viewpointOffsetStarboard
(NSDictionary *)	- missionOverlayDescriptor
(NSDictionary *)	- missionOverlayDescriptorOrDefault
(void)	- setMissionOverlayDescriptor:
(NSDictionary *)	- missionBackgroundDescriptor
(NSDictionary *)	- missionBackgroundDescriptorOrDefault
(void)	- setMissionBackgroundDescriptor:
(OOGUIBackgroundSpecial)	- missionBackgroundSpecial
(void)	- setMissionBackgroundSpecial:
(void)	- setMissionExitScreen:
(OOGUIScreenID)	- missionExitScreen
(void)	- clearExtraMissionKeys
(void)	- setExtraMissionKeys:
(void)	- clearExtraGuiScreenKeys:key:
(BOOL)	- setExtraGuiScreenKeys:definition:
(NSDictionary *)	- equipScreenBackgroundDescriptor
(void)	- setEquipScreenBackgroundDescriptor:
(BOOL)	- scriptsLoaded
(NSArray *)	- worldScriptNames
(NSDictionary *)	- worldScriptsByName
(OOScript *)	- commodityScriptNamed:
(BOOL)	- doWorldEventUntilMissionScreen:
(void)	- doWorldScriptEvent:inContext:withArguments:count:timeLimit:
(BOOL)	- showInfoFlag
(void)	- setGalacticHyperspaceBehaviour:
(OOGalacticHyperspaceBehaviour)	- galacticHyperspaceBehaviour
(void)	- setGalacticHyperspaceFixedCoords:
(void)	- setGalacticHyperspaceFixedCoordsX:y:
(NSPoint)	- galacticHyperspaceFixedCoords
(void)	- setWitchspaceCountdown:
(OOLongRangeChartMode)	- longRangeChartMode
(void)	- setLongRangeChartMode:
(BOOL)	- scoopOverride
(void)	- setScoopOverride:
(void)	- setDockTarget:
(BOOL)	- clearedToDock
(void)	- setDockingClearanceStatus:
(OODockingClearanceStatus)	- getDockingClearanceStatus
(void)	- penaltyForUnauthorizedDocking
(NSArray *)	- scannedWormholes
(WormholeEntity *)	- wormhole
(void)	- setWormhole:
(void)	- addScannedWormhole:
(void)	- initialiseMissionDestinations:andLegacy:
(NSString *)	- markerKey:
(void)	- addMissionDestinationMarker:
(BOOL)	- removeMissionDestinationMarker:
(NSMutableDictionary *)	- getMissionDestinations
(NSMutableDictionary *)	- shipyardRecord
(void)	- setLastShot:
(void)	- showShipModelWithKey:shipData:personality:factorX:factorY:factorZ:inContext:
(void)	- doGuiScreenResizeUpdates
(GLfloat)	- insideAtmosphereFraction
(void)	- setName: [implementation]
(void)	- createCargoPodWithType:andAmount: [implementation]
(id)	- init [implementation]
(BOOL)	- setUpShipFromDictionary: [implementation]
(void)	- dealloc [implementation]
(NSUInteger)	- sessionID [implementation]
(BOOL)	- canCollide [implementation]
(NSComparisonResult)	- compareZeroDistance: [implementation]
(BOOL)	- validForAddToUniverse [implementation]
(GLfloat)	- lookingAtSunWithThresholdAngleCos: [implementation]
(void)	- update: [implementation]
(void)	- updateMovementFlags [implementation]
(void)	- updateAlertConditionForNearbyEntities [implementation]
(void)	- setMaxFlightPitch: [implementation]
(void)	- setMaxFlightRoll: [implementation]
(void)	- setMaxFlightYaw: [implementation]
(BOOL)	- checkEntityForMassLock:withScanClass: [implementation]
(void)	- updateAlertCondition [implementation]
(void)	- updateFuelScoops: [implementation]
(void)	- updateClocks: [implementation]
(void)	- checkScriptsIfAppropriate [implementation]
(void)	- updateTrumbles: [implementation]
(void)	- performAutopilotUpdates: [implementation]
(void)	- performInFlightUpdates: [implementation]
(void)	- performWitchspaceCountdownUpdates: [implementation]
(void)	- performWitchspaceExitUpdates: [implementation]
(void)	- performLaunchingUpdates: [implementation]
(void)	- performDockingUpdates: [implementation]
(void)	- performDeadUpdates: [implementation]
(void)	- gameOverFadeToBW [implementation]
(void)	- showGameOver [implementation]
(void)	- updateTargeting [implementation]
(void)	- orientationChanged [implementation]
(void)	- applyAttitudeChanges: [implementation]
(void)	- applyRoll:andClimb: [implementation]
(OOMatrix)	- drawRotationMatrix [implementation]
(OOMatrix)	- drawTransformationMatrix [implementation]
(Quaternion)	- normalOrientation [implementation]
(void)	- setNormalOrientation: [implementation]
(void)	- moveForward: [implementation]
(void)	- drawImmediate:translucent: [implementation]
(float)	- maxForwardShieldLevel [implementation]
(float)	- maxAftShieldLevel [implementation]
(GLfloat)	- laserHeatLevel [implementation]
(GLfloat)	- laserHeatLevelAft [implementation]
(GLfloat)	- laserHeatLevelForward [implementation]
(GLfloat)	- laserHeatLevelPort [implementation]
(GLfloat)	- laserHeatLevelStarboard [implementation]
(BOOL)	- canScoop: [implementation]
(OOAlertCondition)	- realAlertCondition [implementation]
(void)	- interpretAIMessage: [implementation]
(ShipEntity *)	- fireMissile [implementation]
(void)	- noticeECM [implementation]
(BOOL)	- fireECM [implementation]
(GLfloat)	- doesHitLine:v0:v1: [implementation]
(void)	- takeEnergyDamage:from:becauseOf:weaponIdentifier: [implementation]
(void)	- takeScrapeDamage:from: [implementation]
(void)	- takeHeatDamage: [implementation]
(ProxyPlayerEntity *)	- createDoppelganger [implementation]
(ShipEntity *)	- launchEscapeCapsule [implementation]
(OOCommodityType)	- dumpCargo [implementation]
(void)	- setBounty: [implementation]
(void)	- setBounty:withReason: [implementation]
(void)	- setBounty:withReasonAsString: [implementation]
(OOCreditsQuantity)	- bounty [implementation]
(void)	- markAsOffender: [implementation]
(void)	- markAsOffender:withReason: [implementation]
(void)	- collectBountyFor: [implementation]
(void)	- getDestroyedBy:damageType: [implementation]
(void)	- enterDock: [implementation]
(void)	- leaveDock: [implementation]
(void)	- witchStart [implementation]
(void)	- witchEnd [implementation]
(double)	- hyperspaceJumpDistance [implementation]
(OOFuelQuantity)	- fuelRequiredForJump [implementation]
(void)	- noteCompassLostTarget [implementation]
(void)	- enterWormhole: [implementation]
(void)	- enterWitchspace [implementation]
(void)	- witchJumpTo:misjump: [implementation]
(void)	- leaveWitchspace [implementation]
(OOEquipmentType *)	- weaponTypeForFacing:strict: [implementation]
(NSArray *)	- missilesList [implementation]
(NSArray *)	- cargoListForScripting [implementation]
(NSArray *)	- contractsListForScriptingFromArray:forCargo: [implementation]
(NSArray *)	- passengerListForScripting [implementation]
(NSArray *)	- parcelListForScripting [implementation]
(NSArray *)	- contractListForScripting [implementation]
(void)	- prepareMarkedDestination:markers: [implementation]
(BOOL)	- tryBuyingItem: [implementation]
(OOCreditsQuantity)	- removeMissiles [implementation]
(void)	- doTradeIn:forPriceFactor: [implementation]
(OOCargoQuantity)	- cargoQuantityOnBoard [implementation]
(void)	- showMarketScreenHeaders [implementation]
(void)	- showMarketScreenDataLine:forGood:inMarket:holdQuantity: [implementation]
(NSString *)	- marketScreenTitle [implementation]
(void)	- showMarketCashAndLoadLine [implementation]
(BOOL)	- isMining [implementation]
(BOOL)	- canAddEquipment:inContext: [implementation]
(BOOL)	- addEquipmentItem:inContext: [implementation]
(BOOL)	- addEquipmentItem:withValidation:inContext: [implementation]
(void)	- removeEquipmentItem: [implementation]
(BOOL)	- hasOneEquipmentItem:includeMissiles: [implementation]
(BOOL)	- hasPrimaryWeapon: [implementation]
(BOOL)	- removeExternalStore: [implementation]
(NSUInteger)	- parcelCount [implementation]
(NSUInteger)	- passengerCount [implementation]
(NSUInteger)	- passengerCapacity [implementation]
(BOOL)	- hasHostileTarget [implementation]
(void)	- receiveCommsMessage:from: [implementation]
(void)	- setFoundTarget: [implementation]
(void)	- addTarget: [implementation]
(void)	- doScriptEvent:inContext:withArguments:count: [implementation]
(void)	- updateWormholes [implementation]
(void)	- dumpSelfState [implementation]
(BOOL)	- suppressClangStuff [implementation]
(NSString *)	- processEscapePods
(NSString *)	- checkPassengerContracts
(int)	- passengerReputation
(void)	- increasePassengerReputation:
(void)	- decreasePassengerReputation:
(int)	- parcelReputation
(void)	- increaseParcelReputation:
(void)	- decreaseParcelReputation:
(int)	- contractReputation
(void)	- increaseContractReputation:
(void)	- decreaseContractReputation:
(OOCargoQuantity)	- contractedVolumeForGood:
(void)	- erodeReputation
(void)	- normaliseReputation
(void)	- addMessageToReport:
(BOOL)	- addPassenger:start:destination:eta:fee:advance:risk:
(BOOL)	- removePassenger:
(BOOL)	- addParcel:start:destination:eta:fee:premium:risk:
(BOOL)	- removeParcel:
(BOOL)	- awardContract:commodity:start:destination:eta:fee:premium:
(BOOL)	- removeContract:destination:
(NSArray *)	- passengerList
(NSArray *)	- parcelList
(NSArray *)	- contractList
(void)	- setGuiToManifestScreen
(void)	- setManifestScreenRow:inColor:forRow:ofRows:andOffset:inMultipage:
(void)	- setGuiToDockingReportScreen
(void)	- setGuiToShipyardScreen:
(void)	- showShipyardModel:shipData:personality:
(void)	- showShipyardInfoForSelection
(NSInteger)	- missingSubEntitiesAdjustment
(void)	- showTradeInInformationFooter
(OOCreditsQuantity)	- priceForShipKey:
(BOOL)	- buySelectedShip
(BOOL)	- replaceShipWithNamedShip:
(void)	- newShipCommonSetup:yardInfo:baseInfo:
(NSArray *)	- contractsListFromArray:forCargo:forParcels: [implementation]
(OOCreditsQuantity)	- tradeInValue [implementation]
(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]
(void)	- resetKeyFunctions
(void)	- initCheckingDictionary
(void)	- setGuiToKeyMapperScreen:resetCurrentRow:
(void)	- setGuiToKeyMapperScreen:
(void)	- keyMapperInputHandler:view:
(void)	- setGuiToKeyConfigScreen
(void)	- setGuiToKeyConfigScreen:
(void)	- handleKeyConfigKeys:view:
(void)	- outputKeyDefinition:shift:mod1:mod2:skiprows:
(void)	- setGuiToKeyConfigEntryScreen
(void)	- handleKeyConfigEntryKeys:view:
(void)	- setGuiToConfirmClearScreen
(void)	- handleKeyMapperConfirmClearKeys:view:
(void)	- setGuiToKeyboardLayoutScreen:
(void)	- setGuiToKeyboardLayoutScreen:resetCurrentRow:
(void)	- handleKeyboardLayoutEntryKeys:view:
(NSString *)	- validateKey:checkKeys:
(NSDictionary *)	- makeKeyGuiDict:keyDef:
(NSDictionary *)	- makeKeyGuiDictHeader:
(BOOL)	- entryIsIndexCustomEquip: [implementation]
(BOOL)	- entryIsDictCustomEquip: [implementation]
(BOOL)	- entryIsCustomEquip: [implementation]
(NSArray *)	- getCustomEquipArray: [implementation]
(NSUInteger)	- getCustomEquipIndex: [implementation]
(NSString *)	- getCustomEquipKeyDefType: [implementation]
(void)	- updateKeyDefinition:index: [implementation]
(void)	- updateShiftKeyDefinition:index: [implementation]
(void)	- displayKeyFunctionList:skip: [implementation]
(NSArray *)	- keyFunctionList [implementation]
(NSString *)	- keyboardDescription: [implementation]
(NSArray *)	- keyboardLayoutList [implementation]
(void)	- displayKeyboardLayoutList:skip: [implementation]
(NSArray *)	- validateAllKeys [implementation]
(NSString *)	- searchArrayForMatch:key:checkKeys: [implementation]
(BOOL)	- entryIsEqualToDefault: [implementation]
(BOOL)	- compareKeyEntries:second: [implementation]
(void)	- saveKeySetting: [implementation]
(void)	- unsetKeySetting: [implementation]
(void)	- deleteKeySetting: [implementation]
(void)	- deleteAllKeySettings [implementation]
(NSDictionary *)	- loadKeySettings [implementation]
(void)	- reloadPage [implementation]
(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:
(void)	- pollFlightControls: [implementation]
(void)	- pollFlightArrowKeyControls: [implementation]
(void)	- pollGuiArrowKeyControls: [implementation]
(void)	- handleGameOptionsScreenKeys [implementation]
(void)	- handleKeyMapperScreenKeys [implementation]
(void)	- handleKeyboardLayoutKeys [implementation]
(void)	- handleStickMapperScreenKeys [implementation]
(void)	- pollApplicationControls [implementation]
(void)	- pollCustomViewControls [implementation]
(void)	- pollViewControls [implementation]
(void)	- pollGuiScreenControls [implementation]
(void)	- pollGuiScreenControlsWithFKeyAlias: [implementation]
(void)	- pollMarketScreenControls [implementation]
(void)	- handleUndockControl [implementation]
(void)	- pollGameOverControls: [implementation]
(void)	- pollAutopilotControls: [implementation]
(void)	- pollDockedControls: [implementation]
(void)	- pollDemoControls: [implementation]
(void)	- pollMissionInterruptControls [implementation]
(void)	- handleMissionCallback [implementation]
(void)	- setGuiToMissionEndScreen [implementation]
(void)	- switchToThisView: [implementation]
(void)	- switchToThisView:andProcessWeaponFacing: [implementation]
(void)	- switchToThisView:fromView:andProcessWeaponFacing:justNotify: [implementation]
(void)	- handleAutopilotOn: [implementation]
(void)	- handleButtonIdent [implementation]
(void)	- handleButtonTargetMissile [implementation]
(void)	- setJSSelf:context:
(NSString *)	- oo_jsClassName [implementation]
(void)	- javaScriptEngineWillReset: [implementation]
(void)	- setGuiToLoadCommanderScreen [implementation]
(void)	- setGuiToSaveCommanderScreen: [implementation]
(void)	- setGuiToOverwriteScreen: [implementation]
(void)	- lsCommanders:directory:pageNumber:highlightName: [implementation]
(void)	- showCommanderShip: [implementation]
(int)	- findIndexOfCommander: [implementation]
(void)	- nativeSavePlayer: [implementation]
(BOOL)	- existingNativeSave: [implementation]
(void)	- writePlayerToPath: [implementation]
(NSComparisonResult)	- sortCommanders [implementation]
(void)	- setExtraEquipmentFromFlags [implementation]
(BOOL)	- isPlayerLikeShip [implementation]
(void)	- checkScript
(void)	- setScriptTarget:
(ShipEntity *)	- scriptTarget
(void)	- runScriptActions:withContextName:forTarget:
(void)	- runUnsanitizedScriptActions:allowingAIMethods:withContextName:forTarget:
(BOOL)	- scriptTestConditions:
(NSDictionary *)	- missionVariables
(NSString *)	- missionVariableForKey:
(void)	- setMissionVariable:forKey:
(NSMutableDictionary *)	- localVariablesForMission:
(NSString *)	- localVariableForKey:andMission:
(void)	- setLocalVariable:forKey:andMission:
(NSString *)	- mission_string
(NSString *)	- status_string
(NSString *)	- gui_screen_string
(NSNumber *)	- planet_number
(NSNumber *)	- score_number
(NSNumber *)	- credits_number
(NSNumber *)	- scriptTimer_number
(NSNumber *)	- shipsFound_number
(NSNumber *)	- d100_number
(NSNumber *)	- pseudoFixedD100_number
(NSNumber *)	- d256_number
(NSNumber *)	- pseudoFixedD256_number
(NSNumber *)	- clock_number
(NSNumber *)	- clock_secs_number
(NSNumber *)	- clock_mins_number
(NSNumber *)	- clock_hours_number
(NSNumber *)	- clock_days_number
(NSNumber *)	- fuelLevel_number
(NSString *)	- dockedAtMainStation_bool
(NSString *)	- foundEquipment_bool
(NSString *)	- sunWillGoNova_bool
(NSString *)	- sunGoneNova_bool
(NSString *)	- missionChoice_string
(NSString *)	- missionKeyPress_string
(NSNumber *)	- dockedTechLevel_number
(NSString *)	- dockedStationName_string
(NSNumber *)	- systemGovernment_number
(NSString *)	- systemGovernment_string
(NSNumber *)	- systemEconomy_number
(NSString *)	- systemEconomy_string
(NSNumber *)	- systemTechLevel_number
(NSNumber *)	- systemPopulation_number
(NSNumber *)	- systemProductivity_number
(NSString *)	- commanderName_string
(NSString *)	- commanderRank_string
(NSString *)	- commanderShip_string
(NSString *)	- commanderShipDisplayName_string
(NSString *)	- commanderLegalStatus_string
(NSNumber *)	- commanderLegalStatus_number
(NSArray *)	- missionsList
(void)	- setMissionDescription:
(void)	- clearMissionDescription
(void)	- setMissionInstructions:forMission:
(void)	- setMissionInstructionsList:forMission:
(void)	- setMissionDescription:forMission:
(void)	- clearMissionDescriptionForMission:
(void)	- commsMessage:
(void)	- commsMessageByUnpiloted:
(void)	- consoleMessage3s:
(void)	- consoleMessage6s:
(void)	- setLegalStatus:
(void)	- awardCredits:
(void)	- awardShipKills:
(void)	- awardEquipment:
(void)	- removeEquipment:
(void)	- setPlanetinfo:
(void)	- setSpecificPlanetInfo:
(void)	- awardCargo:
(void)	- removeAllCargo
(void)	- removeAllCargo:
(void)	- useSpecialCargo:
(void)	- testForEquipment:
(void)	- awardFuel:
(void)	- messageShipAIs:
(void)	- ejectItem:
(void)	- addShips:
(void)	- addSystemShips:
(void)	- addShipsAt:
(void)	- addShipsAtPrecisely:
(void)	- addShipsWithinRadius:
(void)	- spawnShip:
(void)	- set:
(void)	- reset:
(void)	- increment:
(void)	- decrement:
(void)	- add:
(void)	- subtract:
(void)	- checkForShips:
(void)	- resetScriptTimer
(void)	- addMissionText:
(void)	- addLiteralMissionText:
(void)	- setMissionChoiceByTextEntry:
(void)	- setMissionChoices:
(void)	- setMissionChoicesDictionary:
(void)	- resetMissionChoice
(void)	- clearMissionScreen
(void)	- addMissionDestination:
(void)	- removeMissionDestination:
(void)	- showShipModel:
(void)	- setMissionMusic:
(NSString *)	- missionTitle
(void)	- setMissionTitle:
(void)	- setFuelLeak:
(NSNumber *)	- fuelLeakRate_number
(void)	- setSunNovaIn:
(void)	- launchFromStation
(void)	- blowUpStation
(void)	- sendAllShipsAway
(OOPlanetEntity *)	- addPlanet:
(OOPlanetEntity *)	- addMoon:
(void)	- debugOn
(void)	- debugOff
(void)	- debugMessage:
(NSString *)	- replaceVariablesInString:
(void)	- playSound:
(BOOL)	- addEqScriptForKey:
(void)	- removeEqScriptForKey:
(NSUInteger)	- eqScriptIndexForKey:
(void)	- targetNearestHostile
(void)	- targetNearestIncomingMissile
(void)	- setGalacticHyperspaceBehaviourTo:
(void)	- setGalacticHyperspaceFixedCoordsTo:
(void)	- clearMissionScreenID
(void)	- setMissionScreenID:
(NSString *)	- missionScreenID
(void)	- setGuiToMissionScreen
(void)	- refreshMissionScreenTextEntry
(void)	- setGuiToMissionScreenWithCallback:
(void)	- doMissionCallback
(void)	- endMissionScreenAndNoteOpportunity
(void)	- setBackgroundFromDescriptionsKey:
(void)	- addScene:atOffset:
(BOOL)	- processSceneDictionary:atOffset:
(BOOL)	- processSceneString:atOffset:
(OOINLINE NSString *)	- CurrentScriptDesc(void) [implementation]
(OOINLINE OOEntityStatus)	- RecursiveRemapStatus [implementation]
(BOOL)	- scriptTestCondition: [implementation]
(NSString *)	- expandScriptRightHandSide: [implementation]
(NSString *)	- expandMessage: [implementation]
(void)	- setMissionImage: [implementation]
(void)	- setMissionBackground: [implementation]
(void)	- scriptActions:forTarget:missionKey: [implementation]
(unsigned)	- score
(void)	- setScore:
(double)	- creditBalance
(void)	- setCreditBalance:
(NSString *)	- dockedStationName
(NSString *)	- dockedStationDisplayName
(BOOL)	- dockedAtMainStation
(void)	- awardCommodityType:amount:
(void)	- resetScannerZoom
(OOGalaxyID)	- currentGalaxyID
(OOSystemID)	- currentSystemID
(void)	- setMissionChoice:
(void)	- setMissionChoice:withEvent:
(void)	- setMissionChoice:keyPress:
(void)	- setMissionChoice:keyPress:withEvent:
(void)	- allowMissionInterrupt
(OOTimeDelta)	- scriptTimer
(unsigned)	- systemPseudoRandom100
(unsigned)	- systemPseudoRandom256
(double)	- systemPseudoRandomFloat
(NSDictionary *)	- passengerContractMarker:
(NSDictionary *)	- parcelContractMarker:
(NSDictionary *)	- cargoContractMarker:
(NSDictionary *)	- defaultMarker:
(NSDictionary *)	- validatedMarker:
(NSString *)	- keyBindingDescription2:
(NSString *)	- getKeyBindingDescription:
(NSString *)	- keyCodeDescription:
(NSString *)	- keyCodeDescriptionShort:
(NSString *)	- commanderKillsAsString
(NSString *)	- commanderBountyAsString
(NSString *)	- creditsFormattedForSubstitution
(NSString *)	- creditsFormattedForLegacySubstitution
(void)	- setUpSound
(void)	- setUpWeaponSounds
(void)	- destroySound
(BOOL)	- isBeeping
(void)	- playIdentOn
(void)	- playIdentOff
(void)	- playIdentLockedOn
(void)	- playMissileArmed
(void)	- playMineArmed
(void)	- playMissileSafe
(void)	- playMissileLockedOn
(void)	- playWeaponsOnline
(void)	- playWeaponsOffline
(void)	- playNextEquipmentSelected
(void)	- playNextMissileSelected
(void)	- playCargoJettisioned
(void)	- playAutopilotOn
(void)	- playAutopilotOff
(void)	- playAutopilotOutOfRange
(void)	- playAutopilotCannotDockWithTarget
(void)	- playSaveOverwriteYes
(void)	- playSaveOverwriteNo
(void)	- playHoldFull
(void)	- playJumpMassLocked
(void)	- playTargetLost
(void)	- playNoTargetInMemory
(void)	- playTargetSwitched
(void)	- playCloakingDeviceOn
(void)	- playCloakingDeviceOff
(void)	- playCloakingDeviceInsufficientEnergy
(void)	- playMenuNavigationUp
(void)	- playMenuNavigationDown
(void)	- playMenuNavigationNot
(void)	- playMenuPagePrevious
(void)	- playMenuPageNext
(void)	- playDismissedReportScreen
(void)	- playDismissedMissionScreen
(void)	- playChangedOption
(void)	- updateFuelScoopSoundWithInterval:
(void)	- startAfterburnerSound
(void)	- stopAfterburnerSound
(void)	- playBuyCommodity
(void)	- playBuyShip
(void)	- playSellCommodity
(void)	- playCantBuyCommodity
(void)	- playCantSellCommodity
(void)	- playCantBuyShip
(void)	- playHyperspaceNoTarget
(void)	- playHyperspaceNoFuel
(void)	- playHyperspaceBlocked
(void)	- playHyperspaceDistanceTooGreat
(void)	- playStandardHyperspace
(void)	- playGalacticHyperspace
(void)	- playHyperspaceAborted
(void)	- playHitByECMSound
(void)	- playFiredECMSound
(void)	- playLaunchFromStation
(void)	- playDockWithStation
(void)	- playExitWitchspace
(void)	- playHostileWarning
(void)	- playAlertConditionRed
(void)	- playIncomingMissile:
(void)	- playEnergyLow
(void)	- playDockingDenied
(void)	- playWitchjumpFailure
(void)	- playWitchjumpMisjump
(void)	- playWitchjumpBlocked
(void)	- playWitchjumpDistanceTooGreat
(void)	- playWitchjumpInsufficientFuel
(void)	- playFuelLeak
(void)	- playShieldHit:weaponIdentifier:
(void)	- playDirectHit:weaponIdentifier:
(void)	- playScrapeDamage:
(void)	- playLaserHit:offset:weaponIdentifier:
(void)	- playWeaponOverheated:
(void)	- playMissileLaunched:weaponIdentifier:
(void)	- playMineLaunched:weaponIdentifier:
(void)	- playEscapePodScooped
(void)	- playAegisCloseToPlanet
(void)	- playAegisCloseToStation
(void)	- playGameOver
(void)	- playLegacyScriptSound:
(void)	- playInterfaceBeep: [implementation]
(void)	- boop [implementation]
(void)	- updateAfterburnerSound [implementation]
(void)	- resetStickFunctions
(void)	- setGuiToStickMapperScreen:resetCurrentRow:
(void)	- setGuiToStickMapperScreen:
(void)	- stickMapperInputHandler:view:
(void)	- updateFunction:
(NSDictionary *)	- makeStickGuiDictHeader:
(NSDictionary *)	- makeStickGuiDict:allowable:axisfn:butfn:
(void)	- checkCustomEquipButtons:ignore: [implementation]
(void)	- removeFunction: [implementation]
(void)	- displayFunctionList:skip: [implementation]
(NSString *)	- describeStickDict: [implementation]
(NSString *)	- hwToString: [implementation]
(NSArray *)	- stickFunctionList [implementation]
(void)	- setGuiToStickProfileScreen:
(void)	- stickProfileInputHandler:view:
(void)	- stickProfileGraphAxisProfile:screenAt:screenSize:
Instance Methods inherited from ShipEntity
(void)	- setStateMachine:
(void)	- setAI:
(AI *)	- getAI
(BOOL)	- hasAutoAI
(BOOL)	- hasNewAI
(void)	- setShipScript:
(void)	- removeScript
(OOScript *)	- shipScript
(OOScript *)	- shipAIScript
(OOTimeAbsolute)	- shipAIScriptWakeTime
(void)	- setAIScriptWakeTime:
(double)	- frustration
(void)	- setLaunchDelay:
(GLfloat)	- accuracy
(void)	- setAccuracy:
(OOMesh *)	- mesh
(void)	- setMesh:
(BoundingBox)	- totalBoundingBox
(Vector)	- forwardVector
(Vector)	- upVector
(Vector)	- rightVector
(NSArray *)	- subEntities
(NSUInteger)	- subEntityCount
(BOOL)	- hasSubEntity:
(NSEnumerator *)	- subEntityEnumerator
(NSEnumerator *)	- shipSubEntityEnumerator
(NSEnumerator *)	- flasherEnumerator
(NSEnumerator *)	- exhaustEnumerator
(ShipEntity *)	- subEntityTakingDamage
(void)	- setSubEntityTakingDamage:
(void)	- clearSubEntities
(Quaternion)	- subEntityRotationalVelocity
(void)	- setSubEntityRotationalVelocity:
(NSString *)	- serializeShipSubEntities
(void)	- deserializeShipSubEntitiesFrom:
(NSUInteger)	- maxShipSubEntities
(void)	- setSubIdx:
(NSUInteger)	- subIdx
(Octree *)	- octree
(float)	- volume
(GLfloat)	- doesHitLine:v0:
(GLfloat)	- doesHitLine:v0:withPosition:andIJK:i:j:
(BoundingBox)	- findBoundingBoxRelativeToPosition:InVectors:i:j:
(HPVector)	- absoluteTractorPosition
(void)	- setIsBoulder:
(BOOL)	- isBoulder
(BOOL)	- isMinable
(BOOL)	- countsAsKill
(void)	- setUpEscorts
(void)	- updateEscortFormation
(id)	- initWithKey:definition:
(BOOL)	- setUpFromDictionary:
(BOOL)	- setUpSubEntities
(BOOL)	- setUpOneStandardSubentity:asTurret:
(GLfloat)	- frustumRadius
(NSString *)	- shipDataKey
(NSString *)	- shipDataKeyAutoRole
(void)	- setShipDataKey:
(NSDictionary *)	- shipInfoDictionary
(NSArray *)	- getWeaponOffsetFrom:withKey:inMode:
(NSArray *)	- aftWeaponOffset
(NSArray *)	- forwardWeaponOffset
(NSArray *)	- portWeaponOffset
(NSArray *)	- starboardWeaponOffset
(BOOL)	- hasAutoWeapons
(BOOL)	- isFrangible
(BOOL)	- suppressFlightNotifications
(void)	- respondToAttackFrom:becauseOf:
(OOWeaponFacingSet)	- weaponFacings
(BOOL)	- hasEquipmentItem:includeWeapons:whileLoading:
(BOOL)	- hasEquipmentItem:
(NSUInteger)	- countEquipmentItem:
(NSString *)	- equipmentItemProviding:
(BOOL)	- hasEquipmentItemProviding:
(BOOL)	- hasAllEquipment:includeWeapons:whileLoading:
(BOOL)	- hasAllEquipment:
(BOOL)	- equipmentValidToAdd:inContext:
(BOOL)	- equipmentValidToAdd:whileLoading:inContext:
(BOOL)	- hasHyperspaceMotor
(float)	- hyperspaceSpinTime
(void)	- setHyperspaceSpinTime:
(NSEnumerator *)	- equipmentEnumerator
(NSUInteger)	- equipmentCount
(void)	- removeAllEquipment
(OOEquipmentType *)	- selectMissile
(BOOL)	- hasOneEquipmentItem:includeWeapons:whileLoading:
(BOOL)	- hasOneEquipmentItem:includeMissiles:whileLoading:
(NSUInteger)	- missileCount
(NSUInteger)	- missileCapacity
(NSUInteger)	- extraCargo
(BOOL)	- hasScoop
(BOOL)	- hasFuelScoop
(BOOL)	- hasCargoScoop
(BOOL)	- hasECM
(BOOL)	- hasCloakingDevice
(BOOL)	- hasMilitaryScannerFilter
(BOOL)	- hasMilitaryJammer
(BOOL)	- hasExpandedCargoBay
(BOOL)	- hasShieldBooster
(BOOL)	- hasMilitaryShieldEnhancer
(BOOL)	- hasHeatShield
(BOOL)	- hasFuelInjection
(BOOL)	- hasCascadeMine
(BOOL)	- hasEscapePod
(BOOL)	- hasDockingComputer
(BOOL)	- hasGalacticHyperdrive
(float)	- shieldBoostFactor
(float)	- shieldRechargeRate
(double)	- maxHyperspaceDistance
(float)	- afterburnerFactor
(float)	- afterburnerRate
(void)	- setAfterburnerFactor:
(void)	- setAfterburnerRate:
(float)	- maxThrust
(float)	- thrust
(void)	- setMaxThrust:
(void)	- setMaxFlightSpeed:
(void)	- setEnergyRechargeRate:
(void)	- processBehaviour:
(void)	- behaviour_stop_still:
(void)	- behaviour_idle:
(void)	- behaviour_tumble:
(void)	- behaviour_tractored:
(void)	- behaviour_track_target:
(void)	- behaviour_intercept_target:
(void)	- behaviour_attack_target:
(void)	- behaviour_attack_slow_dogfight:
(void)	- behaviour_evasive_action:
(void)	- behaviour_attack_break_off_target:
(void)	- behaviour_fly_to_target_six:
(void)	- behaviour_attack_mining_target:
(void)	- behaviour_attack_fly_to_target:
(void)	- behaviour_attack_fly_from_target:
(void)	- behaviour_running_defense:
(void)	- behaviour_flee_target:
(void)	- behaviour_attack_broadside:
(void)	- behaviour_attack_broadside_left:
(void)	- behaviour_attack_broadside_right:
(void)	- behaviour_close_to_broadside_range:
(void)	- behaviour_close_with_target:
(void)	- behaviour_attack_broadside_target:leftside:
(void)	- behaviour_attack_sniper:
(void)	- behaviour_fly_range_from_destination:
(void)	- behaviour_face_destination:
(void)	- behaviour_land_on_planet:
(void)	- behaviour_formation_form_up:
(void)	- behaviour_fly_to_destination:
(void)	- behaviour_fly_from_destination:
(void)	- behaviour_avoid_collision:
(void)	- behaviour_track_as_turret:
(void)	- behaviour_fly_thru_navpoints:
(void)	- behaviour_scripted_ai:
(float)	- reactionTime
(void)	- setReactionTime:
(HPVector)	- calculateTargetPosition
(void)	- startTrackingCurve
(void)	- updateTrackingCurve
(void)	- calculateTrackingCurve
(GLfloat *)	- scannerDisplayColorForShip:otherShip:isHostile:flash:scannerDisplayColor1:scannerDisplayColor2:scannerDisplayColorH1:
(void)	- setScannerDisplayColor1:
(void)	- setScannerDisplayColor2:
(OOColor *)	- scannerDisplayColor1
(OOColor *)	- scannerDisplayColor2
(void)	- setScannerDisplayColorHostile1:
(void)	- setScannerDisplayColorHostile2:
(OOColor *)	- scannerDisplayColorHostile1
(OOColor *)	- scannerDisplayColorHostile2
(BOOL)	- isCloaked
(void)	- setCloaked:
(BOOL)	- hasAutoCloak
(void)	- setAutoCloak:
(void)	- applyThrust:
(void)	- avoidCollision
(void)	- resumePostProximityAlert
(double)	- messageTime
(void)	- setMessageTime:
(OOShipGroup *)	- group
(void)	- setGroup:
(OOShipGroup *)	- escortGroup
(void)	- setEscortGroup:
(OOShipGroup *)	- stationGroup
(BOOL)	- hasEscorts
(NSEnumerator *)	- escortEnumerator
(NSArray *)	- escortArray
(uint8_t)	- escortCount
(uint8_t)	- pendingEscortCount
(void)	- setPendingEscortCount:
(uint8_t)	- maxEscortCount
(void)	- setMaxEscortCount:
(NSUInteger)	- turretCount
(NSString *)	- name
(NSString *)	- shipUniqueName
(NSString *)	- shipClassName
(NSString *)	- displayName
(NSString *)	- scanDescription
(NSString *)	- scanDescriptionForScripting
(void)	- setShipUniqueName:
(void)	- setShipClassName:
(void)	- setDisplayName:
(void)	- setScanDescription:
(NSString *)	- identFromShip:
(BOOL)	- hasRole:
(OORoleSet *)	- roleSet
(void)	- addRole:
(void)	- addRole:withProbability:
(void)	- removeRole:
(NSString *)	- primaryRole
(void)	- setPrimaryRole:
(BOOL)	- hasPrimaryRole:
(BOOL)	- isPolice
(BOOL)	- isThargoid
(BOOL)	- isTrader
(BOOL)	- isPirate
(BOOL)	- isMissile
(BOOL)	- isMine
(BOOL)	- isWeapon
(BOOL)	- isEscort
(BOOL)	- isShuttle
(BOOL)	- isTurret
(BOOL)	- isPirateVictim
(BOOL)	- isExplicitlyUnpiloted
(BOOL)	- isUnpiloted
(BOOL)	- isHostileTo:
(NSUInteger)	- defenseTargetCount
(NSArray *)	- allDefenseTargets
(NSEnumerator *)	- defenseTargetEnumerator
(void)	- validateDefenseTargets
(BOOL)	- addDefenseTarget:
(BOOL)	- isDefenseTarget:
(void)	- removeDefenseTarget:
(void)	- removeAllDefenseTargets
(NSArray *)	- collisionExceptions
(void)	- addCollisionException:
(void)	- removeCollisionException:
(BOOL)	- collisionExceptedFor:
(GLfloat)	- weaponRange
(void)	- setWeaponRange:
(void)	- setWeaponDataFromType:
(float)	- energyRechargeRate
(float)	- weaponRechargeRate
(void)	- setWeaponRechargeRate:
(void)	- setWeaponEnergy:
(OOWeaponFacing)	- currentWeaponFacing
(GLfloat)	- scannerRange
(void)	- setScannerRange:
(Vector)	- reference
(void)	- setReference:
(BOOL)	- reportAIMessages
(void)	- setReportAIMessages:
(void)	- transitionToAegisNone
(OOPlanetEntity *)	- findNearestPlanet
(Entity< OOStellarBody > *)	- findNearestStellarBody
(OOPlanetEntity *)	- findNearestPlanetExcludingMoons
(OOAegisStatus)	- checkForAegis
(void)	- forceAegisCheck
(BOOL)	- withinStationAegis
(void)	- setLastAegisLock:
(OOSystemID)	- homeSystem
(OOSystemID)	- destinationSystem
(void)	- setHomeSystem:
(void)	- setDestinationSystem:
(NSArray *)	- crew
(NSArray *)	- crewForScripting
(void)	- setCrew:
(void)	- setSingleCrewWithRole:
(OOFuelQuantity)	- fuel
(void)	- setFuel:
(OOFuelQuantity)	- fuelCapacity
(GLfloat)	- fuelChargeRate
(void)	- setRoll:
(void)	- setRawRoll:
(void)	- setPitch:
(void)	- setYaw:
(void)	- setThrust:
(void)	- applySticks:
(void)	- setThrustForDemo:
(int)	- legalStatus
(BOOL)	- isTemplateCargoPod
(void)	- setUpCargoType:
(void)	- setCommodity:andAmount:
(void)	- setCommodityForPod:andAmount:
(OOCommodityType)	- commodityType
(OOCargoQuantity)	- commodityAmount
(OOCargoQuantity)	- maxAvailableCargoSpace
(void)	- setMaxAvailableCargoSpace:
(OOCargoQuantity)	- availableCargoSpace
(OOCargoType)	- cargoType
(NSMutableArray *)	- cargo
(void)	- setCargo:
(BOOL)	- addCargo:
(BOOL)	- removeCargo:amount:
(BOOL)	- showScoopMessage
(NSArray *)	- equipmentListForScripting
(OOWeaponType)	- weaponTypeIDForFacing:strict:
(OOCargoFlag)	- cargoFlag
(void)	- setCargoFlag:
(void)	- setSpeed:
(double)	- desiredSpeed
(void)	- setDesiredSpeed:
(double)	- desiredRange
(void)	- setDesiredRange:
(double)	- cruiseSpeed
(Vector)	- thrustVector
(void)	- setTotalVelocity:
(void)	- increase_flight_speed:
(void)	- decrease_flight_speed:
(void)	- increase_flight_roll:
(void)	- decrease_flight_roll:
(void)	- increase_flight_pitch:
(void)	- decrease_flight_pitch:
(void)	- increase_flight_yaw:
(void)	- decrease_flight_yaw:
(GLfloat)	- flightRoll
(GLfloat)	- flightPitch
(GLfloat)	- flightYaw
(GLfloat)	- flightSpeed
(GLfloat)	- maxFlightPitch
(GLfloat)	- maxFlightSpeed
(GLfloat)	- maxFlightRoll
(GLfloat)	- maxFlightYaw
(GLfloat)	- speedFactor
(GLfloat)	- temperature
(void)	- setTemperature:
(GLfloat)	- heatInsulation
(void)	- setHeatInsulation:
(float)	- randomEjectaTemperature
(float)	- randomEjectaTemperatureWithMaxFactor:
(int)	- damage
(void)	- dealEnergyDamage:atRange:withBias:
(void)	- dealEnergyDamageWithinDesiredRange
(void)	- dealMomentumWithinDesiredRange:
(void)	- noteTakingDamage:from:type:
(void)	- noteKilledBy:damageType:
(void)	- becomeExplosion
(void)	- becomeLargeExplosion:
(void)	- becomeEnergyBlast
(void)	- broadcastEnergyBlastImminent
(void)	- setIsWreckage:
(BOOL)	- showDamage
(Vector)	- positionOffsetForAlignment:
(Vector)	- positionOffsetForShipInRotationToAlignment
(BoundingBox)	- findSubentityBoundingBox
(Triangle)	- absoluteIJKForSubentity
(GLfloat)	- weaponRecoveryTime
(GLfloat)	- hullHeatLevel
(GLfloat)	- entityPersonality
(GLint)	- entityPersonalityInt
(void)	- setEntityPersonalityInt:
(void)	- setSuppressExplosion:
(void)	- resetExhaustPlumes
(void)	- removeExhaust:
(void)	- removeFlasher:
(void)	- checkScanner
(void)	- checkScannerIgnoringUnpowered
(ShipEntity **)	- scannedShips
(int)	- numberOfScannedShips
(Entity *)	- foundTarget
(Entity *)	- primaryAggressor
(Entity *)	- lastEscortTarget
(Entity *)	- thankedShip
(Entity *)	- rememberedShip
(Entity *)	- proximityAlert
(void)	- setPrimaryAggressor:
(void)	- setLastEscortTarget:
(void)	- setThankedShip:
(void)	- setRememberedShip:
(void)	- setProximityAlert:
(void)	- setTargetStation:
(void)	- removeTarget:
(BOOL)	- canStillTrackPrimaryTarget
(id)	- primaryTarget
(id)	- primaryTargetWithoutValidityCheck
(StationEntity *)	- targetStation
(BOOL)	- isFriendlyTo:
(ShipEntity *)	- shipHitByLaser
(void)	- noteLostTarget
(void)	- noteLostTargetAndGoIdle
(void)	- noteTargetDestroyed:
(OOBehaviour)	- behaviour
(void)	- setBehaviour:
(void)	- trackOntoTarget:withDForward:
(double)	- ballTrackLeadingTarget:atTarget:
(GLfloat)	- rollToMatchUp:rotating:
(GLfloat)	- rangeToDestination
(double)	- trackDestination:delta_t:
(void)	- setCoordinate:
(HPVector)	- coordinates
(HPVector)	- destination
(HPVector)	- distance_six:
(HPVector)	- distance_twelve:withOffset:
(void)	- setEvasiveJink:
(void)	- evasiveAction:
(double)	- trackPrimaryTarget:delta_t:
(double)	- trackSideTarget:delta_t:
(double)	- missileTrackPrimaryTarget:
(double)	- rangeToPrimaryTarget
(double)	- approachAspectToPrimaryTarget
(double)	- rangeToSecondaryTarget:
(BOOL)	- hasProximityAlertIgnoringTarget:
(GLfloat)	- currentAimTolerance
(BOOL)	- onTarget:withWeapon:
(OOTimeDelta)	- shotTime
(void)	- resetShotTime
(BOOL)	- fireMainWeapon:
(BOOL)	- fireAftWeapon:
(BOOL)	- firePortWeapon:
(BOOL)	- fireStarboardWeapon:
(BOOL)	- fireTurretCannon:
(void)	- setLaserColor:
(void)	- setExhaustEmissiveColor:
(OOColor *)	- laserColor
(OOColor *)	- exhaustEmissiveColor
(BOOL)	- fireSubentityLaserShot:
(BOOL)	- fireDirectLaserShot:
(BOOL)	- fireDirectLaserDefensiveShot
(BOOL)	- fireDirectLaserShotAt:
(NSArray *)	- laserPortOffset:
(BOOL)	- fireLaserShotInDirection:weaponIdentifier:
(void)	- adjustMissedShots:
(int)	- missedShots
(void)	- considerFiringMissile:
(Vector)	- missileLaunchPosition
(ShipEntity *)	- fireMissileWithIdentifier:andTarget:
(BOOL)	- isMissileFlagSet
(void)	- setIsMissileFlag:
(OOTimeDelta)	- missileLoadTime
(void)	- setMissileLoadTime:
(BOOL)	- cascadeIfAppropriateWithDamageAmount:cascadeOwner:
(BOOL)	- launchCascadeMine
(ShipEntity *)	- dumpCargoItem:
(OOCargoType)	- dumpItem:
(void)	- manageCollisions
(BOOL)	- collideWithShip:
(void)	- adjustVelocity:
(void)	- addImpactMoment:fraction:
(void)	- getTractoredBy:
(void)	- scoopIn:
(void)	- scoopUp:
(void)	- scoopUpProcess:processEvents:processMessages:
(BOOL)	- abandonShip
(void)	- enterWormhole:replacing:
(BOOL)	- witchspaceLeavingEffects
(void)	- switchLightsOn
(void)	- switchLightsOff
(BOOL)	- lightsActive
(void)	- setDestination:
(void)	- setEscortDestination:
(BOOL)	- canAcceptEscort:
(BOOL)	- acceptAsEscort:
(void)	- deployEscorts
(void)	- dockEscorts
(void)	- setTargetToNearestFriendlyStation
(void)	- setTargetToNearestStation
(void)	- setTargetToSystemStation
(void)	- landOnPlanet:
(void)	- abortDocking
(NSDictionary *)	- dockingInstructions
(void)	- broadcastThargoidDestroyed
(void)	- broadcastHitByLaserFrom:
(GLfloat)	- sunGlareFilter
(void)	- setSunGlareFilter:
(void)	- sendExpandedMessage:toShip:
(void)	- sendMessage:toShip:withUnpilotedOverride:
(void)	- broadcastAIMessage:
(void)	- broadcastMessage:withUnpilotedOverride:
(void)	- setCommsMessageColor
(void)	- commsMessage:withUnpilotedOverride:
(BOOL)	- markedForFines
(BOOL)	- markForFines
(void)	- spawn:
(int)	- checkShipsInVicinityForWitchJumpExit
(BOOL)	- trackCloseContacts
(void)	- setTrackCloseContacts:
(void)	- setHulk:
(BOOL)	- isHulk
(OOJSScript *)	- script
(NSDictionary *)	- scriptInfo
(void)	- overrideScriptInfo:
(BOOL)	- scriptedMisjump
(void)	- setScriptedMisjump:
(GLfloat)	- scriptedMisjumpRange
(void)	- setScriptedMisjumpRange:
(Entity *)	- entityForShaderProperties
(void)	- setDemoShip:
(BOOL)	- isDemoShip
(void)	- setDemoStartTime:
(void)	- doScriptEvent:
(void)	- doScriptEvent:withArgument:
(void)	- doScriptEvent:withArgument:andArgument:
(void)	- doScriptEvent:withArguments:
(void)	- doScriptEvent:withArguments:count:
(void)	- reactToAIMessage:context:
(void)	- sendAIMessage:
(void)	- doScriptEvent:andReactToAIMessage:
(void)	- doScriptEvent:withArgument:andReactToAIMessage:
(id)	- initBypassForPlayer [implementation]
(NSString *)	- repeatString:times: [implementation]
(BOOL)	- setUpOneSubentity: [implementation]
(BOOL)	- setUpOneFlasher: [implementation]
(NSString *)	- descriptionComponents [implementation]
(NSString *)	- shortDescriptionComponents [implementation]
(BoundingBox)	- findBoundingBoxRelativeToPosition:InVectors:_i:_j: [implementation]
(void)	- wasAddedToUniverse [implementation]
(void)	- wasRemovedFromUniverse [implementation]
(NSString *)	- beaconCode [implementation]
(void)	- setBeaconCode: [implementation]
(NSString *)	- beaconLabel [implementation]
(void)	- setBeaconLabel: [implementation]
(BOOL)	- isVisible [implementation]
(BOOL)	- isBeacon [implementation]
(id< OOHUDBeaconIcon >)	- beaconDrawable [implementation]
(Entity< OOBeaconEntity > *)	- prevBeacon [implementation]
(Entity< OOBeaconEntity > *)	- nextBeacon [implementation]
(void)	- setPrevBeacon: [implementation]
(void)	- setNextBeacon: [implementation]
(void)	- setUpMixedEscorts [implementation]
(void)	- setUpOneEscort:inGroup:withRole:atPosition:andCount: [implementation]
(OOScanClass)	- scanClass [implementation]
(ShipEntity *)	- doOctreesCollide [implementation]
(BOOL)	- checkCloseCollisionWith: [implementation]
(void)	- addSubentityToCollisionRadius: [implementation]
(ShipEntity *)	- launchPodWithCrew: [implementation]
(void)	- noteFrustration: [implementation]
(OOEquipmentType *)	- generateMissileEquipmentTypeFrom: [implementation]
(OOEquipmentType *)	- verifiedMissileTypeFromRole: [implementation]
(void)	- drawDebugStuff [implementation]
(void)	- drawSubEntityImmediate:translucent: [implementation]
(BOOL)	- isJammingScanning [implementation]
(void)	- addSubEntity: [implementation]
(void)	- setOwner: [implementation]
(void)	- applyRoll:climb:andYaw: [implementation]
(OOShipGroup *)	- rawEscortGroup [implementation]
(NSComparisonResult)	- ComparePlanetsBySurfaceDistance [implementation]
(Entity< OOStellarBody > *)	- lastAegisLock [implementation]
(void)	- setStatus: [implementation]
(void)	- rescaleBy: [implementation]
(void)	- rescaleBy:writeToCache: [implementation]
(void)	- releaseCargoPodsDebris [implementation]
(void)	- subEntityDied: [implementation]
(void)	- subEntityReallyDied: [implementation]
(NSComparisonResult)	- compareBeaconCodeWith: [implementation]
(uint32_t)	- randomSeedForShaders [implementation]
(void)	- setShipHitByLaser: [implementation]
(BOOL)	- fireWeapon:direction:range: [implementation]
(void)	- throwSparks [implementation]
(Vector)	- velocity [implementation]
(void)	- refreshEscortPositions [implementation]
(HPVector)	- coordinatesForEscortPosition: [implementation]
(void)	- setTargetToNearestStationIncludingHostiles: [implementation]
(BoundingBox)	- findBoundingBoxRelativeTo:InVectors:_i:_j: [implementation]
(OOTimeAbsolute)	- getDemoStartTime [implementation]
(void)	- doNothing [implementation]
(NSString *)	- descriptionForObjDump [implementation]
(void)	- setAITo:
(void)	- setAIScript:
(void)	- switchAITo:
(void)	- scanForHostiles
(BOOL)	- performHyperSpaceToSpecificSystem:
(void)	- scanForNearestIncomingMissile
(void)	- enterTargetWormhole
(void)	- enterPlayerWormhole
(void)	- wormholeEscorts
(void)	- wormholeEntireGroup
(BOOL)	- suggestEscortTo:
(void)	- groupAttackTarget
(void)	- performAttack
(void)	- performCollect
(void)	- performEscort
(void)	- performFaceDestination
(void)	- performFlee
(void)	- performFlyToRangeFromDestination
(void)	- performHold
(void)	- performIdle
(void)	- performIntercept
(void)	- performLandOnPlanet
(void)	- performMining
(void)	- performScriptedAI
(void)	- performScriptedAttackAI
(void)	- performStop
(void)	- performTumble
(void)	- broadcastDistressMessage
(void)	- broadcastDistressMessageWithDumping:
(void)	- requestDockingCoordinates
(void)	- recallDockingInstructions
(void)	- performBuoyTumble [implementation]
(NSDictionary *)	- savedShipDictionaryWithContext:
(void)	- simplifyShipdata:andGetDeletes: [implementation]
(void)	- checkFoundTarget [implementation]
(BOOL)	- performHyperSpaceExitReplace: [implementation]
(BOOL)	- performHyperSpaceExitReplace:toSystem: [implementation]
(void)	- scanForNearestShipWithPredicate:parameter: [implementation]
(void)	- scanForNearestShipWithNegatedPredicate:parameter: [implementation]
(void)	- acceptDistressMessageFrom: [implementation]
(BOOL)	- launchPatrol [implementation]
(NSArray *)	- subEntitiesForScript
(void)	- setTargetForScript:
(BOOL)	- isVisibleToScripts [implementation]
(void)	- getJSClass:andPrototype: [implementation]
(void)	- setStateTo: [implementation]
(void)	- pauseAI: [implementation]
(void)	- randomPauseAI: [implementation]
(void)	- dropMessages: [implementation]
(void)	- debugDumpPendingMessages [implementation]
(void)	- setDestinationToCurrentLocation [implementation]
(void)	- setDesiredRangeTo: [implementation]
(void)	- setDesiredRangeForWaypoint [implementation]
(void)	- setSpeedTo: [implementation]
(void)	- setSpeedFactorTo: [implementation]
(void)	- setSpeedToCruiseSpeed [implementation]
(void)	- setThrustFactorTo: [implementation]
(void)	- setTargetToPrimaryAggressor [implementation]
(void)	- scanForNearestMerchantman [implementation]
(void)	- scanForRandomMerchantman [implementation]
(void)	- scanForLoot [implementation]
(void)	- scanForRandomLoot [implementation]
(void)	- setTargetToFoundTarget [implementation]
(void)	- checkForFullHold [implementation]
(void)	- getWitchspaceEntryCoordinates [implementation]
(void)	- setDestinationFromCoordinates [implementation]
(void)	- setCoordinatesFromPosition [implementation]
(void)	- fightOrFleeMissile [implementation]
(void)	- setCourseToPlanet [implementation]
(void)	- setTakeOffFromPlanet [implementation]
(void)	- landOnPlanet [implementation]
(void)	- checkTargetLegalStatus [implementation]
(void)	- checkOwnLegalStatus [implementation]
(void)	- exitAIWithMessage: [implementation]
(void)	- setDestinationToTarget [implementation]
(void)	- setDestinationWithinTarget [implementation]
(void)	- checkCourseToDestination [implementation]
(void)	- checkAegis [implementation]
(void)	- checkEnergy [implementation]
(void)	- checkHeatInsulation [implementation]
(void)	- scanForOffenders [implementation]
(void)	- setCourseToWitchpoint [implementation]
(void)	- setDestinationToWitchpoint [implementation]
(void)	- setDestinationToStationBeacon [implementation]
(void)	- performHyperSpaceExit [implementation]
(void)	- performHyperSpaceExitWithoutReplacing [implementation]
(void)	- wormholeGroup [implementation]
(void)	- ejectCargo [implementation]
(void)	- scanForThargoid [implementation]
(void)	- scanForNonThargoid [implementation]
(void)	- thargonCheckMother [implementation]
(void)	- becomeUncontrolledThargon [implementation]
(void)	- checkDistanceTravelled [implementation]
(void)	- fightOrFleeHostiles [implementation]
(void)	- suggestEscort [implementation]
(void)	- escortCheckMother [implementation]
(void)	- checkGroupOddsVersusTarget [implementation]
(void)	- scanForFormationLeader [implementation]
(void)	- messageMother: [implementation]
(void)	- setPlanetPatrolCoordinates [implementation]
(void)	- setSunSkimStartCoordinates [implementation]
(void)	- setSunSkimEndCoordinates [implementation]
(void)	- setSunSkimExitCoordinates [implementation]
(void)	- patrolReportIn [implementation]
(void)	- checkForMotherStation [implementation]
(void)	- sendTargetCommsMessage: [implementation]
(void)	- markTargetForFines [implementation]
(void)	- markTargetForOffence: [implementation]
(void)	- storeTarget [implementation]
(void)	- recallStoredTarget [implementation]
(void)	- scanForRocks [implementation]
(void)	- setDestinationToDockingAbort [implementation]
(void)	- requestNewTarget [implementation]
(void)	- rollD: [implementation]
(void)	- scanForNearestShipWithPrimaryRole: [implementation]
(void)	- scanForNearestShipHavingRole: [implementation]
(void)	- scanForNearestShipWithAnyPrimaryRole: [implementation]
(void)	- scanForNearestShipHavingAnyRole: [implementation]
(void)	- scanForNearestShipWithScanClass: [implementation]
(void)	- scanForNearestShipWithoutPrimaryRole: [implementation]
(void)	- scanForNearestShipNotHavingRole: [implementation]
(void)	- scanForNearestShipWithoutAnyPrimaryRole: [implementation]
(void)	- scanForNearestShipNotHavingAnyRole: [implementation]
(void)	- scanForNearestShipWithoutScanClass: [implementation]
(void)	- setCoordinates: [implementation]
(void)	- checkForNormalSpace [implementation]
(void)	- setTargetToRandomStation [implementation]
(void)	- setTargetToLastStation [implementation]
(void)	- addFuel: [implementation]
(void)	- scriptActionOnTarget: [implementation]
(void)	- sendScriptMessage: [implementation]
(void)	- ai_throwSparks [implementation]
(void)	- explodeSelf [implementation]
(void)	- ai_debugMessage: [implementation]
(void)	- targetFirstBeaconWithCode: [implementation]
(void)	- targetNextBeaconWithCode: [implementation]
(void)	- setRacepointsFromTarget [implementation]
(void)	- performFlyRacepoints [implementation]
(void)	- addPrimaryAggressorAsDefenseTarget [implementation]
(void)	- addFoundTargetAsDefenseTarget [implementation]
(void)	- findNewDefenseTarget [implementation]
(void)	- setDestinationToJinkPosition [implementation]
(void)	- messageSelf: [implementation]
(void)	- scanForNearestShipMatchingPredicate: [implementation]
(void)	- safeScriptActionOnTarget: [implementation]
(ShipEntity *)	- ejectShipOfType:
(ShipEntity *)	- ejectShipOfRole:
(NSArray *)	- spawnShipsWithRole:count:
(BOOL)	- isShipWithSubEntityShip: [implementation]
Instance Methods inherited from OOEntityWithDrawable
(OODrawable *)	- drawable
(void)	- setDrawable:
(double)	- findCollisionRadius [implementation]
(NSSet *)	- allTextures [implementation]
Instance Methods inherited from Entity
(BOOL)	- isShip
(BOOL)	- isDock
(BOOL)	- isStation
(BOOL)	- isSubEntity
(BOOL)	- isPlayer
(BOOL)	- isPlanet
(BOOL)	- isSun
(BOOL)	- isSunlit
(BOOL)	- isStellarObject
(BOOL)	- isSky
(BOOL)	- isWormhole
(BOOL)	- isEffect
(BOOL)	- isVisualEffect
(BOOL)	- isWaypoint
(void)	- addToLinkedLists
(void)	- removeFromLinkedLists
(void)	- updateLinkedLists
(CollisionRegion *)	- collisionRegion
(void)	- setCollisionRegion:
(void)	- setUniversalID:
(OOUniversalID)	- universalID
(BOOL)	- throwingSparks
(void)	- setThrowSparks:
(id)	- owner
(ShipEntity *)	- parentEntity
(ShipEntity *)	- rootShipEntity
(void)	- setPosition:
(void)	- setPositionX:y:z:
(HPVector)	- position
(Vector)	- cameraRelativePosition
(GLfloat)	- cameraRangeFront
(GLfloat)	- cameraRangeBack
(void)	- updateCameraRelativePosition
(Vector)	- vectorTo:
(HPVector)	- absolutePositionForSubentity
(HPVector)	- absolutePositionForSubentityOffset:
(double)	- zeroDistance
(double)	- camZeroDistance
(BoundingBox)	- boundingBox
(GLfloat)	- mass
(Quaternion)	- orientation
(void)	- setOrientation:
(void)	- setVelocity:
(double)	- speed
(GLfloat)	- distanceTravelled
(void)	- setDistanceTravelled:
(OOEntityStatus)	- status
(void)	- setScanClass:
(void)	- setEnergy:
(GLfloat)	- energy
(void)	- setMaxEnergy:
(GLfloat)	- maxEnergy
(OOMatrix)	- rotationMatrix
(OOMatrix)	- transformationMatrix
(GLfloat)	- collisionRadius
(void)	- setCollisionRadius:
(NSMutableArray *)	- collisionArray
(void)	- applyVelocity:
(void)	- dumpState
(NSUInteger)	- lastDrawCounter
(void)	- setLastDrawCounter:
(BOOL)	- isInSpace
(BOOL)	- isImmuneToBreakPatternHide
(GLfloat)	- universalTime
(GLfloat)	- spawnTime
(GLfloat)	- timeElapsedSinceSpawn
(void)	- setAtmosphereFogging:
(OOColor *)	- fogUniform
(NSString *)	- descriptionForObjDumpBasic
(BOOL)	- checkLinkedLists [implementation]
(id< OOWeakReferenceSupport >)	- superShaderBindingTarget [implementation]
(Vector)	- relativePosition [implementation]
(BOOL)	- isBreakPattern
(void)	- inspect [implementation]
(BOOL)	- isECMBlast
(BOOL)	- isExhaust
(BOOL)	- isFlasher
(void)	- deleteJSSelf
(jsval)	- oo_jsValueInContext: [implementation]
(BOOL)	- isCascadeWeapon
(GLfloat)	- clock [implementation]
(unsigned)	- pseudoFixedD100 [implementation]
(unsigned)	- pseudoFixedD256 [implementation]
(unsigned)	- systemGovernment [implementation]
(unsigned)	- systemEconomy [implementation]
(unsigned)	- systemTechLevel [implementation]
(unsigned)	- systemPopulation [implementation]
(unsigned)	- systemProductivity [implementation]
Instance Methods inherited from OOWeakRefObject
(id)	- weakSelf
(id)	- weakRetain [implementation]
(void)	- weakRefDied: [implementation]
Instance Methods inherited from <OOWeakReferenceSupport>
(id)	- OO_RETURNS_RETAINED

Class Methods
(PlayerEntity *)	+ sharedPlayer
(static NSString *)	+ SliderString [implementation]
(static NSString *)	+ CurrentScriptNameOr [implementation]
(static void)	+ PerformScriptActions [implementation]
(static void)	+ PerformConditionalStatment [implementation]
(static void)	+ PerformActionStatment [implementation]
(static BOOL)	+ TestScriptConditions [implementation]
Class Methods inherited from ShipEntity
(static BOOL)	+ IsBehaviourHostile [implementation]
(static float)	+ SurfaceDistanceSqaredV [implementation]
(static float)	+ SurfaceDistanceSqared [implementation]
(static BOOL)	+ AuthorityPredicate [implementation]
(id)	+ shipRestoredFromDictionary:useFallback:context:

Private Attributes
OOSystemID	system_id
OOSystemID	target_system_id
OOSystemID	info_system_id
OOSystemID	previous_system_id
float	occlusion_dial
OOSystemID	found_system_id
int	ship_trade_in_factor
NSDictionary *	worldScripts
NSDictionary *	worldScriptsRequiringTickle
NSMutableDictionary *	commodityScripts
NSMutableDictionary *	mission_variables
NSMutableDictionary *	localVariables
NSString *	_missionTitle
NSInteger	missionTextRow
NSString *	missionChoice
NSString *	missionKeyPress
BOOL	_missionWithCallback
BOOL	_missionAllowInterrupt
BOOL	_missionTextEntry
OOGUIScreenID	_missionExitScreen
NSString *	specialCargo
NSMutableArray *	commLog
NSMutableArray *	eqScripts
NSDictionary *	_missionOverlayDescriptor
NSDictionary *	_missionBackgroundDescriptor
OOGUIBackgroundSpecial	_missionBackgroundSpecial
NSDictionary *	_equipScreenBackgroundDescriptor
NSString *	_missionScreenID
BOOL	found_equipment
NSMutableDictionary *	reputation
unsigned	max_passengers
NSMutableArray *	passengers
NSMutableDictionary *	passenger_record
NSMutableArray *	parcels
NSMutableDictionary *	parcel_record
NSMutableArray *	contracts
NSMutableDictionary *	contract_record
NSMutableDictionary *	shipyard_record
NSMutableDictionary *	missionDestinations
NSMutableArray *	roleWeights
NSMutableDictionary *	roleWeightFlags
NSMutableArray *	roleSystemList
double	script_time
double	script_time_check
double	script_time_interval
NSString *	lastTextKey
double	ship_clock
double	ship_clock_adjust
double	escape_pod_rescue_time
double	fps_check_time
int	fps_counter
double	last_fps_check_time
NSString *	planetSearchString
OOMatrix	playerRotMatrix
BOOL	showingLongRangeChart
NSString *	commanderNameString
NSMutableArray *	cdrDetailArray
int	currentPage
BOOL	pollControls
NSInteger	marketOffset
OOCommodityType	marketSelectedCommodity
OOMarketFilterMode	marketFilterMode
OOMarketSorterMode	marketSorterMode
OOWeakReference *	_dockedStation
StationEntity *	targetDockStation
HeadUpDisplay *	hud
NSMutableDictionary *	multiFunctionDisplayText
NSMutableArray *	multiFunctionDisplaySettings
NSUInteger	activeMFD
NSMutableDictionary *	customDialSettings
GLfloat	roll_delta
GLfloat	pitch_delta
GLfloat	yaw_delta
GLfloat	launchRoll
GLfloat	forward_shield
GLfloat	aft_shield
GLfloat	max_forward_shield
GLfloat	max_aft_shield
GLfloat	forward_shield_recharge_rate
GLfloat	aft_shield_recharge_rate
OOTimeDelta	forward_shot_time
OOTimeDelta	aft_shot_time
OOTimeDelta	port_shot_time
OOTimeDelta	starboard_shot_time
OOWeaponFacing	chosen_weapon_facing
double	ecm_start_time
double	last_ecm_time
OOGUIScreenID	gui_screen
OOAlertFlags	alertFlags
OOAlertCondition	alertCondition
OOAlertCondition	lastScriptAlertCondition
OOPlayerFleeingStatus	fleeing_status
OOMissileStatus	missile_status
NSUInteger	activeMissile
NSUInteger	primedEquipment
NSString *	_fastEquipmentA
NSString *	_fastEquipmentB
OOCargoQuantity	current_cargo
NSPoint	cursor_coordinates
NSPoint	chart_focus_coordinates
NSPoint	chart_centre_coordinates
NSPoint	custom_chart_centre_coordinates
NSPoint	target_chart_centre
NSPoint	target_chart_focus
OOScalar	chart_zoom
OOScalar	custom_chart_zoom
OOScalar	target_chart_zoom
OOScalar	saved_chart_zoom
OORouteType	ANA_mode
OOTimeDelta	witchspaceCountdown
NSString *	_jumpCause
NSString *	_commanderName
NSString *	_lastsaveName
NSPoint	galaxy_coordinates
OOCreditsQuantity	credits
OOGalaxyID	galaxy_number
OOCommodityMarket *	shipCommodityData
ShipEntity *	missile_entity [PLAYER_MAX_MISSILES]
OOUniversalID	_dockTarget
int	legalStatus
int	market_rnd
unsigned	ship_kills
OOCompassMode	compassMode
OOWeakReference *	compassTarget
GLfloat	fuel_leak_rate
GLfloat	hyperspeedFactor
NSDictionary *	keyconfig2_settings
NSDictionary *	keyCodeLookups
NSArray *	n_key_roll_left
NSArray *	n_key_roll_right
NSArray *	n_key_pitch_forward
NSArray *	n_key_pitch_back
NSArray *	n_key_yaw_left
NSArray *	n_key_yaw_right
NSArray *	n_key_view_forward
NSArray *	n_key_view_aft
NSArray *	n_key_view_port
NSArray *	n_key_view_starboard
NSArray *	n_key_launch_ship
NSArray *	n_key_gui_screen_options
NSArray *	n_key_gui_screen_equipship
NSArray *	n_key_gui_screen_interfaces
NSArray *	n_key_gui_screen_status
NSArray *	n_key_gui_chart_screens
NSArray *	n_key_gui_system_data
NSArray *	n_key_gui_market
NSArray *	n_key_gui_arrow_left
NSArray *	n_key_gui_arrow_right
NSArray *	n_key_gui_arrow_up
NSArray *	n_key_gui_arrow_down
NSArray *	n_key_gui_page_up
NSArray *	n_key_gui_page_down
NSArray *	n_key_gui_select
NSArray *	n_key_increase_speed
NSArray *	n_key_decrease_speed
NSArray *	n_key_inject_fuel
NSArray *	n_key_fire_lasers
NSArray *	n_key_launch_missile
NSArray *	n_key_next_missile
NSArray *	n_key_ecm
NSArray *	n_key_prime_next_equipment
NSArray *	n_key_prime_previous_equipment
NSArray *	n_key_activate_equipment
NSArray *	n_key_mode_equipment
NSArray *	n_key_fastactivate_equipment_a
NSArray *	n_key_fastactivate_equipment_b
NSArray *	n_key_target_missile
NSArray *	n_key_untarget_missile
NSArray *	n_key_target_incoming_missile
NSArray *	n_key_ident_system
NSArray *	n_key_scanner_zoom
NSArray *	n_key_scanner_unzoom
NSArray *	n_key_launch_escapepod
NSArray *	n_key_galactic_hyperspace
NSArray *	n_key_hyperspace
NSArray *	n_key_jumpdrive
NSArray *	n_key_dump_cargo
NSArray *	n_key_rotate_cargo
NSArray *	n_key_autopilot
NSArray *	n_key_autodock
NSArray *	n_key_snapshot
NSArray *	n_key_docking_music
NSArray *	n_key_advanced_nav_array_next
NSArray *	n_key_advanced_nav_array_previous
NSArray *	n_key_info_next_system
NSArray *	n_key_info_previous_system
NSArray *	n_key_map_home
NSArray *	n_key_map_end
NSArray *	n_key_map_next_system
NSArray *	n_key_map_previous_system
NSArray *	n_key_map_info
NSArray *	n_key_map_zoom_in
NSArray *	n_key_map_zoom_out
NSArray *	n_key_system_home
NSArray *	n_key_system_end
NSArray *	n_key_system_next_system
NSArray *	n_key_system_previous_system
NSArray *	n_key_pausebutton
NSArray *	n_key_show_fps
NSArray *	n_key_bloom_toggle
NSArray *	n_key_mouse_control_roll
NSArray *	n_key_mouse_control_yaw
NSArray *	n_key_hud_toggle
NSArray *	n_key_comms_log
NSArray *	n_key_prev_compass_mode
NSArray *	n_key_next_compass_mode
NSArray *	n_key_chart_highlight
NSArray *	n_key_market_filter_cycle
NSArray *	n_key_market_sorter_cycle
NSArray *	n_key_market_buy_one
NSArray *	n_key_market_sell_one
NSArray *	n_key_market_buy_max
NSArray *	n_key_market_sell_max
NSArray *	n_key_next_target
NSArray *	n_key_previous_target
NSArray *	n_key_custom_view
NSArray *	n_key_custom_view_zoom_out
NSArray *	n_key_custom_view_zoom_in
NSArray *	n_key_custom_view_roll_left
NSArray *	n_key_custom_view_pan_left
NSArray *	n_key_custom_view_roll_right
NSArray *	n_key_custom_view_pan_right
NSArray *	n_key_custom_view_rotate_up
NSArray *	n_key_custom_view_pan_up
NSArray *	n_key_custom_view_rotate_down
NSArray *	n_key_custom_view_pan_down
NSArray *	n_key_custom_view_rotate_left
NSArray *	n_key_custom_view_rotate_right
NSArray *	n_key_docking_clearance_request
NSArray *	n_key_weapons_online_toggle
NSArray *	n_key_cycle_next_mfd
NSArray *	n_key_cycle_previous_mfd
NSArray *	n_key_switch_next_mfd
NSArray *	n_key_switch_previous_mfd
NSArray *	n_key_oxzmanager_setfilter
NSArray *	n_key_oxzmanager_showinfo
NSArray *	n_key_oxzmanager_extract
NSArray *	n_key_dump_target_state
NSArray *	n_key_dump_entity_list
NSArray *	n_key_debug_full
NSArray *	n_key_debug_collision
NSArray *	n_key_debug_console_connect
NSArray *	n_key_debug_bounding_boxes
NSArray *	n_key_debug_shaders
NSArray *	n_key_debug_off
NSMutableArray *	customEquipActivation
NSMutableArray *	customActivatePressed
NSMutableArray *	customModePressed
NSDictionary *	extraMissionKeys
NSMutableDictionary *	extraGuiScreenKeys
NSString *	save_path
NSString *	scenarioKey
Vector	forwardViewOffset
Vector	aftViewOffset
Vector	portViewOffset
Vector	starboardViewOffset
Vector	_sysInfoLight
NSUInteger	trumbleCount
OOTrumble *	trumble [PLAYER_MAX_TRUMBLES]
float	_trumbleAppetiteAccumulator
GLfloat	scanner_zoom_rate
NSMutableArray *	target_memory
NSUInteger	target_memory_index
Quaternion	customViewQuaternion
OOMatrix	customViewMatrix
Vector	customViewOffset
Vector	customViewForwardVector
Vector	customViewUpVector
Vector	customViewRightVector
Vector	customViewRotationCenter
NSString *	customViewDescription
NSMutableString *	dockingReport
unsigned	suppressTargetLost: 1
unsigned	scoopsActive: 1
unsigned	scoopOverride: 1
unsigned	game_over: 1
unsigned	finished: 1
unsigned	bomb_detonated: 1
unsigned	autopilot_engaged: 1
unsigned	afterburner_engaged: 1
unsigned	afterburnerSoundLooping: 1
unsigned	hyperspeed_engaged: 1
unsigned	travelling_at_hyperspeed: 1
unsigned	hyperspeed_locked: 1
unsigned	ident_engaged: 1
unsigned	galactic_witchjump: 1
unsigned	ecm_in_operation: 1
unsigned	show_info_flag: 1
unsigned	showDemoShips: 1
unsigned	rolling
unsigned	pitching
unsigned	yawing: 1
unsigned	using_mining_laser: 1
unsigned	mouse_control_on: 1
unsigned	keyboardRollOverride: 1
unsigned	keyboardPitchOverride: 1
unsigned	keyboardYawOverride: 1
unsigned	waitingForStickCallback: 1
unsigned	weapons_online: 1
unsigned	launchingMissile: 1
unsigned	replacingMissile: 1
unsigned	massLockable: 1
OOSpeechSettings	isSpeechOn
int	selFunctionIdx
NSArray *	stickFunctions
NSArray *	keyFunctions
NSArray *	kbdLayouts
NSString *	keyShiftText
NSString *	keyMod1Text
NSString *	keyMod2Text
OOGalacticHyperspaceBehaviour	galacticHyperspaceBehaviour
NSPoint	galacticHyperspaceFixedCoords
OOLongRangeChartMode	longRangeChartMode
NSArray *	_customViews
NSUInteger	_customViewIndex
OODockingClearanceStatus	dockingClearanceStatus
NSMutableArray *	scannedWormholes
WormholeEntity *	wormhole
ShipEntity *	demoShip
NSArray *	lastShot
StickProfileScreen *	stickProfileScreen
double	maxFieldOfView
double	fieldOfView

Additional Inherited Members
Public Attributes inherited from ShipEntity
OOTimeDelta	shot_time
Vector	v_forward
Vector	v_up
Vector	v_right
HPVector	_destination
GLfloat	desired_range
GLfloat	desired_speed
GLfloat	stick_roll
GLfloat	stick_pitch
GLfloat	stick_yaw
OOBehaviour	behaviour
BoundingBox	totalBoundingBox
Public Attributes inherited from Entity
OOUniversalID	universalID
unsigned	isShip: 1
unsigned	isStation: 1
unsigned	isPlayer: 1
unsigned	isWormhole: 1
unsigned	isSubEntity: 1
unsigned	hasMoved: 1
unsigned	hasRotated: 1
unsigned	hasCollided: 1
unsigned	isSunlit: 1
unsigned	collisionTestFilter: 2
unsigned	throw_sparks: 1
unsigned	isImmuneToBreakPatternHide: 1
unsigned	isExplicitlyNotMainStation: 1
unsigned	isVisualEffect: 1
OOScanClass	scanClass
GLfloat	zero_distance
GLfloat	cam_zero_distance
GLfloat	no_draw_distance
GLfloat	collision_radius
HPVector	position
Vector	cameraRelativePosition
Quaternion	orientation
OOColor *	atmosphereFogging
int	zero_index
Entity *	x_previous
Entity *	x_next
Entity *	y_previous
Entity *	y_next
Entity *	z_previous
Entity *	z_next
Entity *	collision_chain
OOUniversalID	shadingEntityID
Entity *	collider
CollisionRegion *	collisionRegion
Protected Attributes inherited from ShipEntity
NSDictionary *	shipinfoDictionary
Quaternion	subentityRotationalVelocity
OOJSScript *	script
OOJSScript *	aiScript
OOTimeAbsolute	aiScriptWakeTime
NSDictionary *	dockingInstructions
OOColor *	laser_color
OOColor *	default_laser_color
OOColor *	exhaust_emissive_color
OOColor *	scanner_display_color1
OOColor *	scanner_display_color2
OOColor *	scanner_display_color_hostile1
OOColor *	scanner_display_color_hostile2
GLfloat	maxFlightSpeed
GLfloat	max_flight_roll
GLfloat	max_flight_pitch
GLfloat	max_flight_yaw
GLfloat	cruiseSpeed
GLfloat	max_thrust
GLfloat	thrust
float	hyperspaceMotorSpinTime
unsigned	military_jammer_active: 1
unsigned	docking_match_rotation: 1
unsigned	pitching_over: 1
unsigned	rolling_over: 1
unsigned	reportAIMessages: 1
unsigned	being_mined: 1
unsigned	being_fined: 1
unsigned	isHulk: 1
unsigned	trackCloseContacts: 1
unsigned	isNearPlanetSurface: 1
unsigned	isFrangible: 1
unsigned	cloaking_device_active: 1
unsigned	cloakPassive: 1
unsigned	cloakAutomatic: 1
unsigned	canFragment: 1
unsigned	isWreckage: 1
unsigned	_showDamage: 1
unsigned	suppressExplosion: 1
unsigned	suppressAegisMessages: 1
unsigned	isMissile: 1
unsigned	_explicitlyUnpiloted: 1
unsigned	hasScoopMessage: 1
unsigned	scripted_misjump: 1
unsigned	haveExecutedSpawnAction: 1
unsigned	haveStartedJSAI: 1
unsigned	noRocks: 1
unsigned	_lightsActive: 1
GLfloat	_scriptedMisjumpRange
GLfloat	sunGlareFilter
OOFuelQuantity	fuel
GLfloat	fuel_accumulator
GLfloat	afterburner_rate
GLfloat	afterburner_speed_factor
OOCargoQuantity	likely_cargo
OOCargoQuantity	max_cargo
OOCargoQuantity	extra_cargo
OOCargoQuantity	equipment_weight
OOCargoType	cargo_type
OOCargoFlag	cargo_flag
OOCreditsQuantity	bounty
GLfloat	energy_recharge_rate
OOWeaponFacingSet	weapon_facings
OOWeaponType	forward_weapon_type
OOWeaponType	aft_weapon_type
OOWeaponType	port_weapon_type
OOWeaponType	starboard_weapon_type
GLfloat	weapon_damage
GLfloat	weapon_damage_override
GLfloat	weaponRange
OOWeaponFacing	currentWeaponFacing
GLfloat	weapon_energy_use
GLfloat	weapon_temp
GLfloat	weapon_shot_temperature
GLfloat	forward_weapon_temp
GLfloat	aft_weapon_temp
GLfloat	port_weapon_temp
GLfloat	starboard_weapon_temp
GLfloat	scannerRange
unsigned	missiles
unsigned	max_missiles
NSString *	_missileRole
OOTimeDelta	missile_load_time
OOTimeAbsolute	missile_launch_time
AI *	shipAI
NSString *	name
NSString *	shipUniqueName
NSString *	shipClassName
NSString *	displayName
NSString *	scan_description
OORoleSet *	roleSet
NSString *	primaryRole
NSArray *	explosionType
Vector	jink
HPVector	coordinates
Vector	reference
NSUInteger	_subIdx
NSUInteger	_maxShipSubIdx
double	launch_time
double	launch_delay
OOUniversalID	planetForLanding
GLfloat	frustration
GLfloat	success_factor
int	patrol_counter
NSMutableDictionary *	previousCondition
float	weapon_recharge_rate
int	shot_counter
OOTimeAbsolute	cargo_dump_time
OOTimeAbsolute	last_shot_time
NSMutableArray *	cargo
OOCommodityType	commodity_type
OOCargoQuantity	commodity_amount
GLfloat	flightSpeed
GLfloat	flightRoll
GLfloat	flightPitch
GLfloat	flightYaw
GLfloat	accuracy
GLfloat	pitch_tolerance
GLfloat	aim_tolerance
int	_missed_shots
OOAegisStatus	aegis_status
OOSystemID	home_system
OOSystemID	destination_system
double	messageTime
double	next_spark_time
Vector	collision_vector
GLfloat	_scaleFactor
BOOL	_multiplyWeapons
NSArray *	forwardWeaponOffset
NSArray *	aftWeaponOffset
NSArray *	portWeaponOffset
NSArray *	starboardWeaponOffset
NSArray *	crew
NSMutableDictionary *	closeContactsInfo
NSString *	lastRadioMessage
Vector	tractor_position
float	ship_temperature
ShipEntity *	scanned_ships [MAX_SCAN_NUMBER+1]
GLfloat	distance2_scanned_ships [MAX_SCAN_NUMBER+1]
unsigned	n_scanned_ships
HPVector	navpoints [32]
unsigned	next_navpoint_index
unsigned	number_of_navpoints
Octree *	octree
OOBehaviour	debugLastBehaviour
uint16_t	entity_personality
NSDictionary *	scriptInfo
NSMutableArray *	subEntities
OOEquipmentType *	missile_list [SHIPENTITY_MAX_MISSILES]
OOWeakReference *	_primaryTarget
OOWeakReference *	_primaryAggressor
OOWeakReference *	_targetStation
OOWeakReference *	_foundTarget
OOWeakReference *	_lastEscortTarget
OOWeakReference *	_thankedShip
OOWeakReference *	_rememberedShip
OOWeakReference *	_proximityAlert
float	reactionTime
HPVector	trackingCurvePositions [4]
OOTimeAbsolute	trackingCurveTimes [4]
HPVector	trackingCurveCoeffs [3]
Protected Attributes inherited from Entity
HPVector	lastPosition
Quaternion	lastOrientation
GLfloat	distanceTravelled
OOMatrix	rotMatrix
Vector	velocity
GLfloat	energy
GLfloat	maxEnergy
BoundingBox	boundingBox
GLfloat	mass
NSMutableArray *	collidingEntities
OOTimeAbsolute	spawnTime
struct JSObject *	_jsSelf
NSUInteger	lastDrawCounter
Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Detailed Description

Definition at line 364 of file PlayerEntity.h.

Method Documentation

activateCloakingDevice

- (BOOL) activateCloakingDevice

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    if (![self hasCloakingDevice])  return NO;
    
    if ([super activateCloakingDevice])
    {
        [UNIVERSE setCurrentPostFX:OO_POSTFX_CLOAK];
        [UNIVERSE addMessage:DESC(@"cloak-on") forCount:2];
        [self playCloakingDeviceOn];
        return YES;
    }
    else
    {
        [UNIVERSE addMessage:DESC(@"cloak-low-juice") forCount:3];
        [self playCloakingDeviceInsufficientEnergy];
        return NO;
    }
}

References int(), and OOCommodityMarket::massUnitForGood:.

Here is the call graph for this function:

activatePrimableEquipment:withMode:

- (void) activatePrimableEquipment:		(NSUInteger)	index
withMode:		(OOPrimedEquipmentMode)	mode

Definition at line 13727 of file PlayerEntity.m.

                                  :(NSUInteger)index withMode:(OOPrimedEquipmentMode)mode
{
    // index == [eqScripts count] means we don't want to activate any equipment.
    if(index < [eqScripts count])
    {
        OOJSScript *eqScript = [[eqScripts oo_arrayAtIndex:index] objectAtIndex:1];
        JSContext *context = OOJSAcquireContext();
        NSAssert1(mode <= OOPRIMEDEQUIP_MODE, @"Primable equipment mode %i out of range", (int)mode);
        
        switch (mode)
        {
            case OOPRIMEDEQUIP_MODE:
                [eqScript callMethod:OOJSID("mode") inContext:context withArguments:NULL count:0 result:NULL];
                break;
            case OOPRIMEDEQUIP_ACTIVATED:
                [eqScript callMethod:OOJSID("activated") inContext:context withArguments:NULL count:0 result:NULL];
                break;
        }
        OOJSRelinquishContext(context);
    }
 
}

activateSelectedInterface

- (void) activateSelectedInterface

Definition at line 9242 of file PlayerEntity.m.

{
    GuiDisplayGen* gui = [UNIVERSE gui];
    NSString* key = [gui selectedRowKey];
 
    if ([key hasPrefix:@"More:"])
    {
        int         from_item = [[key componentsSeparatedByString:@":"] oo_intAtIndex:1];
        [self setGuiToInterfacesScreen:from_item];
 
        if ([gui selectedRow] < 0)
            [gui setSelectedRow:GUI_ROW_INTERFACES_START];
        if (from_item == 0)
            [gui setSelectedRow:GUI_ROW_INTERFACES_START + GUI_MAX_ROWS_INTERFACES - 1];
        [self showInformationForSelectedInterface];
 
 
        return;
    }
 
    NSDictionary *interfaces = [[self dockedStation] localInterfaces];
    OOJSInterfaceDefinition *definition = [interfaces objectForKey:key];
    if (definition)
    {
        [[UNIVERSE gameView] clearKeys];
        [definition runCallback:key];
    }
    else
    {
        OOLog(@"interface.missingCallback", @"Unable to find callback definition for key %@", key);
    }
}

References GUI_MAX_ROWS_EQUIPMENT, GUI_ROW_EQUIPMENT_START, GuiDisplayGen::keyForRow:, last_outfitting_key, setGuiToEquipShipScreen:, GuiDisplayGen::setSelectedRow:, and showInformationForSelectedUpgrade.

Here is the call graph for this function:

activeMFD

- (NSUInteger) activeMFD

activeMissile

- (NSUInteger) activeMissile

add:

- (void) add:

(NSString *)

missionVariableString_value

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

            :(NSString *)missionVariableString_value
{
    NSString*   missionVariableString = nil;
    NSString*   valueString;
    double  value;
    NSMutableArray* tokens = ScanTokensFromString(missionVariableString_value);
    BOOL hasMissionPrefix, hasLocalPrefix;
 
    if ([tokens count] < 2)
    {
        OOLog(kOOLogSyntaxAdd, @"***** SCRIPT ERROR: in %@, CANNOT ADD: '%@'", CurrentScriptDesc(), missionVariableString_value);
        return;
    }
 
    missionVariableString = [tokens objectAtIndex:0];
    [tokens removeObjectAtIndex:0];
    valueString = [tokens componentsJoinedByString:@" "];
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
 
    if (hasMissionPrefix)
    {
        value = [[self missionVariableForKey:missionVariableString] doubleValue];
        value += [valueString doubleValue];
        [self setMissionVariable:[NSString stringWithFormat:@"%f", value] forKey:missionVariableString];
    }
    else if (hasLocalPrefix)
    {
        value = [[self localVariableForKey:missionVariableString andMission:sCurrentMissionKey] doubleValue];
        value += [valueString doubleValue];
        [self setLocalVariable:[NSString stringWithFormat:@"%f", value] forKey:missionVariableString andMission:sCurrentMissionKey];
    }
    else
    {
        OOLog(kOOLogSyntaxAdd, @"***** SCRIPT ERROR: in %@, CANNOT ADD: '%@' -- IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString_value, missionVariableString_value);
    }
}

addEqScriptForKey:

- (BOOL) addEqScriptForKey:

(NSString *)

eq_key

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                          :(NSString *)eq_key
{
    if (eq_key == nil) return NO;
    
    NSString            *scriptName = [[OOEquipmentType equipmentTypeWithIdentifier:eq_key] scriptName];
    
    OOLog(@"player.equipmentScript", @"Added equipment %@, with the following script property: '%@'.", eq_key, scriptName);
 
    if (scriptName == nil) return NO;
    
    NSMutableDictionary *properties = [NSMutableDictionary dictionary];
    
    // no duplicates!
    NSArray *eqScript = nil;
    foreach (eqScript, eqScripts)
    {
        NSString *key = [eqScript oo_stringAtIndex:0];
        if ([key isEqualToString: eq_key])  return NO;
    }
    
    [properties setObject:self forKey:@"ship"];
    [properties setObject:eq_key forKey:@"equipmentKey"];
    OOScript *s = [OOScript jsScriptFromFileNamed:scriptName properties:properties];
    if (s == nil) return NO;
    
    OOLog(@"player.equipmentScript", @"Script '%@': installation %@successful.", scriptName,(s == nil ? @"un" : @""));
    
    [eqScripts addObject:[NSArray arrayWithObjects:eq_key,s,nil]];
    if (primedEquipment == [eqScripts count] - 1) primedEquipment++;    // if primed-none, keep it as primed-none.
    OOLog(@"player.equipmentScript", @"Scriptable equipment available: %llu.", [eqScripts count]);
    return YES;
}

addEquipmentFromCollection:

- (void) addEquipmentFromCollection:

(id)

equipment

Definition at line 9242 of file PlayerEntity.m.

                                   :(id)equipment
{
    NSDictionary    *dict = nil;
    NSEnumerator    *eqEnum = nil;
    NSString    *eqDesc = nil;
    NSUInteger  i, count;
 
    // Pass 1: Load the entire collection.
    if ([equipment isKindOfClass:[NSDictionary class]])
    {
        dict = equipment;
        eqEnum = [equipment keyEnumerator];
    }
    else if ([equipment isKindOfClass:[NSArray class]] || [equipment isKindOfClass:[NSSet class]])
    {
        eqEnum = [equipment objectEnumerator];
    }
    else if ([equipment isKindOfClass:[NSString class]])
    {
        eqEnum = [[NSArray arrayWithObject:equipment] objectEnumerator];
    }
    else
    {
        return;
    }
    
    while ((eqDesc = [eqEnum nextObject]))
    {
        /*  Bug workaround: extra_equipment should never contain EQ_TRUMBLE,
            which is basically a magic flag passed to awardEquipment: to infect
            the player. However, prior to Oolite 1.70.1, if the player had a
            trumble infection and awardEquipment:EQ_TRUMBLE was called, an
            EQ_TRUMBLE would be added to the equipment list. Subsequent calls
            to awardEquipment:EQ_TRUMBLE would exit early because there was an
            EQ_TRUMBLE in the equipment list. as a result, it would no longer
            be possible to infect the player after the current infection ended.
            
            The bug is fixed in 1.70.1. The following line is to fix old saved
            games which had been "corrupted" by the bug.
            -- Ahruman 2007-12-04
         */
        if ([eqDesc isEqualToString:@"EQ_TRUMBLE"])  continue;
        
        // Traditional form is a dictionary of booleans; we only accept those where the value is true.
        if (dict != nil && ![dict oo_boolForKey:eqDesc])  continue;
        
        // We need to add the entire collection without validation first and then remove the items that are
        // not compliant (like items that do not satisfy the requiresEquipment criterion). This is to avoid
        // unintentionally excluding valid equipment, just because the required equipment existed but had
        // not been yet added to the equipment list at the time of the canAddEquipment validation check.
        // Nikos, 20080817.
        count = [dict oo_unsignedIntegerForKey:eqDesc];
        for (i=0;i<count;i++)
        {
            [self addEquipmentItem:eqDesc withValidation:NO inContext:@"loading"];
        }
    }
    
    // Pass 2: Remove items that do not satisfy validation criteria (like requires_equipment etc.).
    if ([equipment isKindOfClass:[NSDictionary class]])
    {
        eqEnum = [equipment keyEnumerator];
    }
    else if ([equipment isKindOfClass:[NSArray class]] || [equipment isKindOfClass:[NSSet class]])
    {
        eqEnum = [equipment objectEnumerator];
    }
    else if ([equipment isKindOfClass:[NSString class]])
    {
        eqEnum = [[NSArray arrayWithObject:equipment] objectEnumerator];
    }
    // Now remove items that should not be in the equipment list.
    while ((eqDesc = [eqEnum nextObject]))
    {
        if (![self equipmentValidToAdd:eqDesc whileLoading:YES inContext:@"loading"])
        {
            [self removeEquipmentItem:eqDesc];
        }
    }
}

addEquipmentItem:inContext:

- (BOOL) addEquipmentItem: (NSString *)  equipmentKey inContext: (NSString *)  context

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                         :(NSString *)equipmentKey inContext:(NSString *)context
{
    return [self addEquipmentItem:equipmentKey withValidation:YES inContext:context];
}

addEquipmentItem:withValidation:inContext:

- (BOOL) addEquipmentItem: (NSString *)  equipmentKey withValidation: (BOOL)  validateAddition inContext: (NSString *)  context

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                         :(NSString *)equipmentKey withValidation:(BOOL)validateAddition inContext:(NSString *)context
{
    // deal with trumbles..
    if ([equipmentKey isEqualToString:@"EQ_TRUMBLE"])
    {
        /*  Bug fix: must return here if eqKey == @"EQ_TRUMBLE", even if
            trumbleCount >= 1. Otherwise, the player becomes immune to
            trumbles. See comment in -setCommanderDataFromDictionary: for more
            details.
         -- Ahruman 2008-12-04
         */
        // the old trumbles will kill the new one if there are enough of them.
        if ((trumbleCount < PLAYER_MAX_TRUMBLES / 6) || (trumbleCount < PLAYER_MAX_TRUMBLES / 3 && ranrot_rand() % 2 > 0))
        {
            [self addTrumble:trumble[ranrot_rand() % PLAYER_MAX_TRUMBLES]]; // randomise its looks.
            return YES;
        }
        return NO;
    }
    
    BOOL OK = [super addEquipmentItem:equipmentKey withValidation:validateAddition inContext:context];
    
    if (OK)
    {
        if ([self hasEquipmentItemProviding:@"EQ_ADVANCED_COMPASS"] && [self compassMode] == COMPASS_MODE_BASIC)
        {
            [self setCompassMode:COMPASS_MODE_PLANET];
        }
        
        [self addEqScriptForKey:equipmentKey];
        [self addEquipmentWithScriptToCustomKeyArray:equipmentKey];
    }
    return OK;
}

Referenced by ShipAwardEquipment().

Here is the caller graph for this function:

addEquipmentWithScriptToCustomKeyArray:

- (void) addEquipmentWithScriptToCustomKeyArray:

(NSString *)

equipmentKey

Definition at line 9242 of file PlayerEntity.m.

                                               :(NSString *)equipmentKey
{
    NSDictionary *item;
    NSUInteger i, j;
    NSArray *object;
 
    for (i = 0; i < [eqScripts count]; i++) 
    {
        if ([[[eqScripts oo_arrayAtIndex:i] oo_stringAtIndex:0] isEqualToString:equipmentKey]) 
        {
            //check if this equipment item is already in the array
            for (j = 0; j < [customEquipActivation count]; j++) {
                item = [customEquipActivation objectAtIndex:j];
                if ([[item oo_stringForKey:CUSTOMEQUIP_EQUIPKEY] isEqualToString:equipmentKey]) return;
            }
            // if we get here, this item is new
            // add the basic info at this point (equipkey and name only)
            OOEquipmentType *eq = [OOEquipmentType equipmentTypeWithIdentifier:equipmentKey];
            NSMutableDictionary *customKey = [[NSMutableDictionary alloc] initWithObjectsAndKeys:equipmentKey, CUSTOMEQUIP_EQUIPKEY, [eq name], CUSTOMEQUIP_EQUIPNAME, nil];
            
            // grab any default keys from the equipment item
            // default activate
            object = [eq defaultActivateKey];
            if ((object != nil && [object count] > 0))
                [customKey setObject:object forKey:CUSTOMEQUIP_KEYACTIVATE];
            // default mode
            object = [eq defaultModeKey];
            if ((object != nil && [object count] > 0))
                [customKey setObject:object forKey:CUSTOMEQUIP_KEYMODE];
 
            [customEquipActivation addObject:customKey];
            [customKey release];
            // keep the keypress arrays in sync
            [customActivatePressed addObject:[NSNumber numberWithBool:NO]];
            [customModePressed addObject:[NSNumber numberWithBool:NO]];         
 
            NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
            [defaults setObject:customEquipActivation forKey:KEYCONFIG_CUSTOMEQUIP];
            return;
        }
    }
}

addLiteralMissionText:

- (void) addLiteralMissionText:

(NSString *)

text

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                              :(NSString *)text
{
    if (text != nil)
    {
        GuiDisplayGen *gui = [UNIVERSE gui];
        
        NSString *para = nil;
        foreach (para, [text componentsSeparatedByString:@"\n"])
        {
            missionTextRow = [gui addLongText:para startingAtRow:missionTextRow align:GUI_ALIGN_LEFT];
        }
    }
}

Referenced by MissionAddMessageText(), and MissionRunScreen().

Here is the caller graph for this function:

addMessageToReport:

- (void) addMessageToReport:

(NSString*)

report

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                           :(NSString*) report
{
    if ([report length] != 0)
    {
        if ([dockingReport length] == 0)
            [dockingReport appendString:report];
        else
            [dockingReport appendFormat:@"\n\n%@", report];
    }
}

Referenced by PlayerAddMessageToArrivalReport().

Here is the caller graph for this function:

addMissionDestination:

- (void) addMissionDestination:

(NSString *)

destinations

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                              :(NSString *)destinations
{
    unsigned j;
    int dest;
    NSMutableArray *tokens = ScanTokensFromString(destinations);
    
    for (j = 0; j < [tokens count]; j++)
    {
        dest = [tokens oo_intAtIndex:j];
        if (dest < 0 || dest > 255)
            continue;
 
        [self addMissionDestinationMarker:[self defaultMarker:dest]];
    }
}

addMissionDestinationMarker:

- (void) addMissionDestinationMarker:

(NSDictionary *)

marker

Definition at line 9242 of file PlayerEntity.m.

                                    :(NSDictionary *)marker
{
    NSDictionary *validated = [self validatedMarker:marker];
    if (validated == nil) 
    {
        return;
    }
    
    [missionDestinations setObject:validated forKey:[self markerKey:validated]];
}

Referenced by MissionMarkSystem().

Here is the caller graph for this function:

addMissionText:

- (void) addMissionText:

(NSString *)

textKey

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                       : (NSString *)textKey
{
    NSString            *text = nil;
    
    if ([textKey isEqualToString:lastTextKey])  return; // don't repeatedly add the same text
    [lastTextKey release];
    lastTextKey = [textKey copy];
    
    // Replace literal \n in strings with line breaks and perform expansions.
    text = [[UNIVERSE missiontext] oo_stringForKey:textKey];
    if (text == nil)  return;
    text = OOExpandWithOptions(OOStringExpanderDefaultRandomSeed(), kOOExpandBackslashN, text);
    text = [self replaceVariablesInString:text];
    
    [self addLiteralMissionText:text];
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

addMoon:

- (OOPlanetEntity *) addMoon:

(NSString *)

moonKey

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                            : (NSString *)moonKey
{
    OOLog(kOOLogNoteAddPlanet, @"DEBUG: addMoon '%@'", moonKey);
 
    if (!UNIVERSE)
        return nil;
    NSDictionary* dict = [[UNIVERSE systemManager] getPropertiesForSystemKey:moonKey];
    if (!dict)
    {
        OOLog(@"script.error.addPlanet.keyNotFound", @"***** ERROR: could not find an entry in planetinfo.plist for '%@'", moonKey);
        return nil;
    }
 
    OOLog(kOOLogDebugAddPlanet, @"DEBUG: initMoonFromDictionary: %@", dict);
    OOPlanetEntity *planet = [[[OOPlanetEntity alloc] initFromDictionary:dict withAtmosphere:NO andSeed:[[UNIVERSE systemManager] getRandomSeedForCurrentSystem] forSystem:system_id] autorelease];
    
    Quaternion planetOrientation;
    if (ScanQuaternionFromString([dict objectForKey:@"orientation"], &planetOrientation))
    {
        [planet setOrientation:planetOrientation];
    }
 
    if (![dict objectForKey:@"position"])
    {
        OOLog(@"script.error.addPlanet.noPosition", @"***** ERROR: you must specify a position for scripted moon '%@' before it can be created", moonKey);
        return nil;
    }
    
    NSString *positionString = [dict objectForKey:@"position"];
    if([positionString hasPrefix:@"abs "] && ([UNIVERSE planet] != nil || [UNIVERSE sun] !=nil))
    {
        OOLogWARN(@"script.deprecated", @"setting %@ for %@ '%@' in 'abs' inside .plists can cause compatibility issues across Oolite versions. Use coordinates relative to main system objects instead.",@"position",@"moon",moonKey);
    }
    HPVector posn = [UNIVERSE coordinatesFromCoordinateSystemString:positionString];
    if (posn.x || posn.y || posn.z)
    {
        OOLog(kOOLogDebugAddPlanet, @"moon position (%.2f %.2f %.2f) derived from %@", posn.x, posn.y, posn.z, positionString);
    }
    else
    {
        ScanHPVectorFromString(positionString, &posn);
        OOLog(kOOLogDebugAddPlanet, @"moon position (%.2f %.2f %.2f) derived from %@", posn.x, posn.y, posn.z, positionString);
    }
    [planet setPosition: posn];
    
    [UNIVERSE addEntity:planet];
    return planet;
}

Referenced by SystemAddMoon().

Here is the caller graph for this function:

addParcel:start:destination:eta:fee:premium:risk:

- (BOOL) addParcel:		(NSString*)	Name
start:		(unsigned)	start
destination:		(unsigned)	destination
eta:		(double)	eta
fee:		(double)	fee
premium:		(double)	premium
risk:		(unsigned)	risk

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                  :(NSString*)Name start:(unsigned)start destination:(unsigned)Destination eta:(double)eta fee:(double)fee premium:(double)premium risk:(unsigned)risk
{
    NSDictionary* parcel_info = [NSDictionary dictionaryWithObjectsAndKeys:
        Name,                                           PASSENGER_KEY_NAME,
        [NSNumber numberWithInt:start],                 CONTRACT_KEY_START,
        [NSNumber numberWithInt:Destination],           CONTRACT_KEY_DESTINATION,
        [NSNumber numberWithDouble:[PLAYER clockTime]], CONTRACT_KEY_DEPARTURE_TIME,
        [NSNumber numberWithDouble:eta],                CONTRACT_KEY_ARRIVAL_TIME,
        [NSNumber numberWithDouble:fee],                CONTRACT_KEY_FEE,
        [NSNumber numberWithDouble:premium],            CONTRACT_KEY_PREMIUM,
        [NSNumber numberWithUnsignedInt:risk],          CONTRACT_KEY_RISK,
        NULL];
    
    // extra checks, just in case.
    // FIXME: do we absolutely need this check? can we live
    // with parcels of senders who happen to have the same
    // name? - Nikos 20160527
    //if ([parcel_record objectForKey:Name] != nil) return NO;
 
    if (risk > 1)
    {
        [self addRoleToPlayer:@"trader-courier+"];
    }
        
    [parcels addObject:parcel_info];
    [parcel_record setObject:[NSNumber numberWithDouble:eta] forKey:Name];
 
    [self doScriptEvent:OOJSID("playerEnteredContract") withArguments:[NSArray arrayWithObjects:@"parcel",parcel_info,nil]];
 
    return YES;
}

Referenced by PlayerShipAddParcel().

Here is the caller graph for this function:

addPassenger:start:destination:eta:fee:advance:risk:

- (BOOL) addPassenger:		(NSString*)	Name
start:		(unsigned)	start
destination:		(unsigned)	destination
eta:		(double)	eta
fee:		(double)	fee
advance:		(double)	advance
risk:		(unsigned)	risk

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                     :(NSString*)Name start:(unsigned)start destination:(unsigned)Destination eta:(double)eta fee:(double)fee advance:(double)advance risk:(unsigned)risk
{
    NSDictionary* passenger_info = [NSDictionary dictionaryWithObjectsAndKeys:
        Name,                                           PASSENGER_KEY_NAME,
        [NSNumber numberWithInt:start],                 CONTRACT_KEY_START,
        [NSNumber numberWithInt:Destination],           CONTRACT_KEY_DESTINATION,
        [NSNumber numberWithDouble:[PLAYER clockTime]], CONTRACT_KEY_DEPARTURE_TIME,
        [NSNumber numberWithDouble:eta],                CONTRACT_KEY_ARRIVAL_TIME,
        [NSNumber numberWithDouble:fee],                CONTRACT_KEY_FEE,
        [NSNumber numberWithDouble:advance],            CONTRACT_KEY_PREMIUM,
        [NSNumber numberWithUnsignedInt:risk],          CONTRACT_KEY_RISK,
 
        NULL];
    
    // extra checks, just in case.
    if ([passengers count] >= max_passengers || [passenger_record objectForKey:Name] != nil) return NO;
        
    if (risk > 1)
    {
        [self addRoleToPlayer:@"trader-courier+"];
    }
 
    [passengers addObject:passenger_info];
    [passenger_record setObject:[NSNumber numberWithDouble:eta] forKey:Name];
 
    [self doScriptEvent:OOJSID("playerEnteredContract") withArguments:[NSArray arrayWithObjects:@"passenger",passenger_info,nil]];
 
    return YES;
}

Referenced by PlayerShipAddPassenger().

Here is the caller graph for this function:

addPlanet:

- (OOPlanetEntity *) addPlanet:

(NSString *)

planetKey

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                              : (NSString *)planetKey
{
    OOLog(kOOLogNoteAddPlanet, @"addPlanet: %@", planetKey);
 
    if (!UNIVERSE)
        return nil;
    NSDictionary* dict = [[UNIVERSE systemManager] getPropertiesForSystemKey:planetKey];
    if (!dict)
    {
        OOLog(@"script.error.addPlanet.keyNotFound", @"***** ERROR: could not find an entry in planetinfo.plist for '%@'", planetKey);
        return nil;
    }
 
    /*- add planet -*/
    OOLog(kOOLogDebugAddPlanet, @"DEBUG: initPlanetFromDictionary: %@", dict);
    OOPlanetEntity *planet = [[[OOPlanetEntity alloc] initFromDictionary:dict withAtmosphere:YES andSeed:[[UNIVERSE systemManager] getRandomSeedForCurrentSystem] forSystem:system_id] autorelease];
    
    Quaternion planetOrientation;
    if (ScanQuaternionFromString([dict objectForKey:@"orientation"], &planetOrientation))
    {
        [planet setOrientation:planetOrientation];
    }
 
    if (![dict objectForKey:@"position"])
    {
        OOLog(@"script.error.addPlanet.noPosition", @"***** ERROR: you must specify a position for scripted planet '%@' before it can be created", planetKey);
        return nil;
    }
    
    NSString *positionString = [dict objectForKey:@"position"];
    if([positionString hasPrefix:@"abs "] && ([UNIVERSE planet] != nil || [UNIVERSE sun] !=nil))
    {
        OOLogWARN(@"script.deprecated", @"setting %@ for %@ '%@' in 'abs' inside .plists can cause compatibility issues across Oolite versions. Use coordinates relative to main system objects instead.",@"position",@"planet",planetKey);
    }
    
    HPVector posn = [UNIVERSE coordinatesFromCoordinateSystemString:positionString];
    if (posn.x || posn.y || posn.z)
    {
        OOLog(kOOLogDebugAddPlanet, @"planet position (%.2f %.2f %.2f) derived from %@", posn.x, posn.y, posn.z, positionString);
    }
    else
    {
        ScanHPVectorFromString(positionString, &posn);
        OOLog(kOOLogDebugAddPlanet, @"planet position (%.2f %.2f %.2f) derived from %@", posn.x, posn.y, posn.z, positionString);
    }
    [planet setPosition: posn];
    
    [UNIVERSE addEntity:planet];
    return planet;
}

Referenced by SystemAddPlanet().

Here is the caller graph for this function:

addRoleForAggression:

- (void) addRoleForAggression:

(ShipEntity *)

victim

Definition at line 13727 of file PlayerEntity.m.

                             :(ShipEntity *)victim
{
    if ([victim isExplicitlyUnpiloted] || [victim isHulk] || [victim hasHostileTarget] || [[victim primaryAggressor] isPlayer])
    {
        return;
    }
    NSString *role = nil;
    if ([[victim primaryRole] isEqualToString:@"escape-capsule"])
    {
        role = @"assassin-player";
    }
    else if ([victim bounty] > 0)
    {
        role = @"hunter";
    }
    else if ([victim isPirateVictim])
    {
        role = @"pirate";
    }
    else if ([UNIVERSE role:[self primaryRole] isInCategory:@"oolite-hunter"] || [victim scanClass] == CLASS_POLICE)
    {
        role = @"pirate-interceptor";
    }
    if (role == nil)
    {
        return;
    }
    NSUInteger times = [roleWeightFlags oo_intForKey:role defaultValue:0];
    times++;
    [roleWeightFlags setObject:[NSNumber numberWithUnsignedInteger:times] forKey:role];
    if ((times & (times-1)) == 0) // is power of 2
    {
        [self addRoleToPlayer:role];
    }
}

addRoleForMining

- (void) addRoleForMining

Definition at line 13727 of file PlayerEntity.m.

{
    NSString *role = @"miner";
    NSUInteger times = [roleWeightFlags oo_intForKey:role defaultValue:0];
    times++;
    [roleWeightFlags setObject:[NSNumber numberWithUnsignedInteger:times] forKey:role];
    if ((times & (times-1)) == 0) // is power of 2
    {
        [self addRoleToPlayer:role];
    }
}

addRoleToPlayer:

- (void) addRoleToPlayer:

(NSString *)

role

Definition at line 13727 of file PlayerEntity.m.

                        :(NSString *)role
{
    NSUInteger slot = Ranrot() & ([self maxPlayerRoles]-1);
    [self addRoleToPlayer:role inSlot:slot];
}

Referenced by PlayerSetPlayerRole().

Here is the caller graph for this function:

addRoleToPlayer:inSlot:

- (void) addRoleToPlayer:		(NSString *)	role
inSlot:		(NSUInteger)	slot

Definition at line 13727 of file PlayerEntity.m.

                        :(NSString *)role inSlot:(NSUInteger)slot
{
    if (slot >= [self maxPlayerRoles])
    {
        slot = [self maxPlayerRoles]-1;
    }
    if (slot >= [roleWeights count])
    {
        [roleWeights addObject:role];
    }
    else
    {
        [roleWeights replaceObjectAtIndex:slot withObject:role];
    }
}

Referenced by PlayerSetPlayerRole().

Here is the caller graph for this function:

addScannedWormhole:

- (void) addScannedWormhole:

(WormholeEntity*)

wormhole

Definition at line 9242 of file PlayerEntity.m.

                          :(WormholeEntity*)whole
{
    assert(scannedWormholes != nil);
    assert(whole != nil);
    
    // Only add if we don't have it already!
    WormholeEntity *wh = nil;
    foreach (wh, scannedWormholes)
    {
        if (wh == whole)  return;
    }
    [whole setScannedAt:[self clockTimeAdjusted]];
    [scannedWormholes addObject:whole];
}

addScenarioModel:

- (void) addScenarioModel:

(NSString *)

shipKey

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 of file PlayerEntityLoadSave.m.

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

addScene:atOffset:

- (void) addScene:		(NSArray *)	items
atOffset:		(Vector)	off

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                 :(NSArray *)items atOffset:(Vector)off
{
    unsigned                i;
    
    if (items == nil)  return;
    
    for (i = 0; i < [items count]; i++)
    {
        id item = [items objectAtIndex:i];
        if ([item isKindOfClass:[NSString class]])
        {
            [self processSceneString:item atOffset: off];
        }
        else if ([item isKindOfClass:[NSArray class]])
        {
            [self addScene:item atOffset: off];
        }
        else if ([item isKindOfClass:[NSDictionary class]])
        {
            [self processSceneDictionary:item atOffset: off];
        }
    }
}

addShips:

- (void) addShips:

(NSString *)

roles_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                 :(NSString *)roles_number
{
    NSMutableArray* tokens = ScanTokensFromString(roles_number);
    NSString*   roleString = nil;
    NSString*   numberString = nil;
    
    if ([tokens count] != 2)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, CANNOT addShips: '%@' (expected <role> <count>)", CurrentScriptDesc(), roles_number);
        return;
    }
    
    roleString = [tokens objectAtIndex:0];
    numberString = [tokens objectAtIndex:1];
    
    int number = [numberString intValue];
    if (number < 0)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, can't add %i ships -- that's less than zero, y'know..", CurrentScriptDesc(), number);
        return;
    }
    
    OOLog(kOOLogNoteAddShips, @"DEBUG: Going to add %d ships with role '%@'", number, roleString);
    
    while (number--)
        [UNIVERSE witchspaceShipWithPrimaryRole:roleString];
}

addShipsAt:

- (void) addShipsAt:

(NSString *)

roles_number_system_x_y_z

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                   :(NSString *)roles_number_system_x_y_z
{
    NSMutableArray* tokens = ScanTokensFromString(roles_number_system_x_y_z);
 
    NSString*   roleString = nil;
    NSString*   numberString = nil;
    NSString*   systemString = nil;
    NSString*   xString = nil;
    NSString*   yString = nil;
    NSString*   zString = nil;
 
    if ([tokens count] != 6)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, CANNOT addShipsAt: '%@' (expected <role> <count> <coordinate-system> <x> <y> <z>)", CurrentScriptDesc(), roles_number_system_x_y_z);
        return;
    }
 
    roleString = [tokens objectAtIndex:0];
    numberString = [tokens objectAtIndex:1];
    systemString = [tokens objectAtIndex:2];
    xString = [tokens objectAtIndex:3];
    yString = [tokens objectAtIndex:4];
    zString = [tokens objectAtIndex:5];
 
    HPVector posn = make_HPvector([xString doubleValue], [yString doubleValue], [zString doubleValue]);
 
    int number = [numberString intValue];
    if (number < 1)
    {
        OOLog(kOOLogSyntaxAddShips, @"----- WARNING in %@  Tried to add %i ships -- no ship added.", CurrentScriptDesc(), number);
        return;
    }
 
    OOLog(kOOLogNoteAddShips, @"DEBUG: Going to add %d ship(s) with role '%@' at point (%.3f, %.3f, %.3f) using system %@", number, roleString, posn.x, posn.y, posn.z, systemString);
 
    if (![UNIVERSE addShips: number withRole:roleString nearPosition: posn withCoordinateSystem: systemString])
    {
        OOLog(kOOLogScriptAddShipsFailed, @"***** SCRIPT ERROR: in %@, %@ could not add %u ships with role \"%@\"", CurrentScriptDesc(), @"addShipsAt:", number, roleString);
    }
}

Referenced by SystemLegacyAddShipsAt().

Here is the caller graph for this function:

addShipsAtPrecisely:

- (void) addShipsAtPrecisely:

(NSString *)

roles_number_system_x_y_z

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                            :(NSString *)roles_number_system_x_y_z
{
    NSMutableArray* tokens = ScanTokensFromString(roles_number_system_x_y_z);
 
    NSString*   roleString = nil;
    NSString*   numberString = nil;
    NSString*   systemString = nil;
    NSString*   xString = nil;
    NSString*   yString = nil;
    NSString*   zString = nil;
 
    if ([tokens count] != 6)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@,* CANNOT addShipsAtPrecisely: '%@' (expected <role> <count> <coordinate-system> <x> <y> <z>)", CurrentScriptDesc(), roles_number_system_x_y_z);
        return;
    }
 
    roleString = [tokens objectAtIndex:0];
    numberString = [tokens objectAtIndex:1];
    systemString = [tokens objectAtIndex:2];
    xString = [tokens objectAtIndex:3];
    yString = [tokens objectAtIndex:4];
    zString = [tokens objectAtIndex:5];
 
    HPVector posn = make_HPvector([xString doubleValue], [yString doubleValue], [zString doubleValue]);
 
    int number = [numberString intValue];
    if (number < 1)
    {
        OOLog(kOOLogSyntaxAddShips, @"----- WARNING: in %@, Can't add %i ships -- no ship added.", CurrentScriptDesc(), number);
        return;
    }
 
    OOLog(kOOLogNoteAddShips, @"DEBUG: Going to add %d ship(s) with role '%@' precisely at point (%.3f, %.3f, %.3f) using system %@", number, roleString, posn.x, posn.y, posn.z, systemString);
 
    if (![UNIVERSE addShips: number withRole:roleString atPosition: posn withCoordinateSystem: systemString])
    {
        OOLog(kOOLogScriptAddShipsFailed, @"***** SCRIPT ERROR: in %@, %@ could not add %u ships with role '%@'", CurrentScriptDesc(), @"addShipsAtPrecisely:", number, roleString);
    }
}

Referenced by SystemLegacyAddShipsAtPrecisely().

Here is the caller graph for this function:

addShipsWithinRadius:

- (void) addShipsWithinRadius:

(NSString *)

roles_number_system_x_y_z_r

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                             :(NSString *)roles_number_system_x_y_z_r
{
    NSMutableArray* tokens = ScanTokensFromString(roles_number_system_x_y_z_r);
 
    if ([tokens count] != 7)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, CANNOT 'addShipsWithinRadius: %@' (expected <role> <count> <coordinate-system> <x> <y> <z> <radius>))", CurrentScriptDesc(), roles_number_system_x_y_z_r);
        return;
    }
 
    NSString* roleString = [tokens objectAtIndex:0];
    int number = [[tokens objectAtIndex:1] intValue];
    NSString* systemString = [tokens objectAtIndex:2];
    double x = [[tokens objectAtIndex:3] doubleValue];
    double y = [[tokens objectAtIndex:4] doubleValue];
    double z = [[tokens objectAtIndex:5] doubleValue];
    GLfloat r = [[tokens objectAtIndex:6] floatValue];
    HPVector posn = make_HPvector(x, y, z);
 
    if (number < 1)
    {
        OOLog(kOOLogSyntaxAddShips, @"----- WARNING: in %@, can't add %i ships -- no ship added.", CurrentScriptDesc(), number);
        return;
    }
 
    OOLog(kOOLogNoteAddShips, @"DEBUG: Going to add %d ship(s) with role '%@' within %.2f radius about point (%.3f, %.3f, %.3f) using system %@", number, roleString, r, x, y, z, systemString);
 
    if (![UNIVERSE addShips:number withRole: roleString nearPosition: posn withCoordinateSystem: systemString withinRadius: r])
    {
        OOLog(kOOLogScriptAddShipsFailed, @"***** SCRIPT ERROR :in %@, %@ could not add %u ships with role \"%@\"", CurrentScriptDesc(), @"addShipsWithinRadius:", number, roleString);
    }
}

Referenced by SystemLegacyAddShipsWithinRadius().

Here is the caller graph for this function:

addSystemShips:

- (void) addSystemShips:

(NSString *)

roles_number_position

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                       :(NSString *)roles_number_position
{
    NSMutableArray* tokens = ScanTokensFromString(roles_number_position);
    NSString*   roleString = nil;
    NSString*   numberString = nil;
    NSString*   positionString = nil;
 
    if ([tokens count] != 3)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, CANNOT addSystemShips: '%@' (expected <role> <count> <position>)", CurrentScriptDesc(), roles_number_position);
        return;
    }
 
    roleString = [tokens objectAtIndex:0];
    numberString = [tokens objectAtIndex:1];
    positionString = [tokens objectAtIndex:2];
 
    int number = [numberString intValue];
    double posn = [positionString doubleValue];
    if (number < 0)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, can't add %i ships -- that's less than zero, y'know..", CurrentScriptDesc(), number);
        return;
    }
 
    OOLog(kOOLogNoteAddShips, @"DEBUG: Going to add %d ships with role '%@' at a point %.3f along route1", number, roleString, posn);
 
    while (number--)
        [UNIVERSE addShipWithRole:roleString nearRouteOneAt:posn];
}

addTarget:

- (void) addTarget: (Entity *)  targetEntity

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                  :(Entity *) targetEntity
{
    if ([self status] != STATUS_IN_FLIGHT && [self status] != STATUS_WITCHSPACE_COUNTDOWN)  return;
    if (targetEntity == self)  return;
    
    [super addTarget:targetEntity];
    
    if ([targetEntity isWormhole])
    {
        assert ([self hasEquipmentItemProviding:@"EQ_WORMHOLE_SCANNER"]);
        [self addScannedWormhole:(WormholeEntity*)targetEntity];
    }
    // wormholes don't go in target memory
    else if ([self hasEquipmentItemProviding:@"EQ_TARGET_MEMORY"] && targetEntity != nil)
    {
        OOWeakReference *targetRef = [targetEntity weakSelf];
        NSUInteger i = [target_memory indexOfObject:targetRef];
        // if already in target memory, preserve that and just change the index
        if (i != NSNotFound)
        {
            target_memory_index = i;
        }       
        else
        {
            i = [target_memory indexOfObject:[NSNull null]];
            // find and use a blank space in memory
            if (i != NSNotFound)
            {
                [target_memory replaceObjectAtIndex:i withObject:targetRef];
                target_memory_index = i;
            }
            else
            {
                // use the next memory space
                target_memory_index = (target_memory_index + 1) % PLAYER_TARGET_MEMORY_SIZE;
                [target_memory replaceObjectAtIndex:target_memory_index withObject:targetRef];
            }
        }
    }
    
    if (ident_engaged)
    {
        [self playIdentLockedOn];
        [self printIdentLockedOnForMissile:NO];
    }
    else if ([targetEntity isShip] && [self weaponsOnline]) // Only let missiles target-lock onto ships
    {
        if ([missile_entity[activeMissile] isMissile])
        {
            missile_status = MISSILE_STATUS_TARGET_LOCKED;
            [missile_entity[activeMissile] addTarget:targetEntity];
            [self playMissileLockedOn];
            [self printIdentLockedOnForMissile:YES];
        }
        else // It's a mine or something
        {
            missile_status = MISSILE_STATUS_ARMED;
            [self playIdentLockedOn];
            [self printIdentLockedOnForMissile:NO];
        }
    }
}

addToAdjustTime:

- (void) addToAdjustTime:

(double)

seconds

Definition at line 13727 of file PlayerEntity.m.

                        :(double)seconds
{
    ship_clock_adjust += seconds;
}

Referenced by PlayerSetEscapePodDestination().

Here is the caller graph for this function:

addTrumble:

- (void) addTrumble:

(OOTrumble *)

papaTrumble

Definition at line 9242 of file PlayerEntity.m.

                   :(OOTrumble *)papaTrumble
{
    if (trumbleCount >= PLAYER_MAX_TRUMBLES)
    {
        return;
    }
    OOTrumble *trumblePup = trumble[trumbleCount];
    [trumblePup spawnFrom:papaTrumble];
    trumbleCount++;
}

adjusted_chart_centre

- (NSPoint) adjusted_chart_centre

Definition at line 13727 of file PlayerEntity.m.

{
    NSPoint acc;        // adjusted chart centre
    double scroll_pos;  // cursor coordinate at which we'd want to scoll chart in the direction we're currently considering
    double ecc;     // chart centre coordinate we'd want if the cursor was on the edge of the galaxy in the current direction
 
    if(_missionBackgroundSpecial == GUI_BACKGROUND_SPECIAL_SHORT ||
        _missionBackgroundSpecial == GUI_BACKGROUND_SPECIAL_SHORT_ANA_QUICKEST || 
        _missionBackgroundSpecial == GUI_BACKGROUND_SPECIAL_SHORT_ANA_SHORTEST)
    {
        return galaxy_coordinates;
    }
    else if(_missionBackgroundSpecial == GUI_BACKGROUND_SPECIAL_LONG ||
            _missionBackgroundSpecial == GUI_BACKGROUND_SPECIAL_LONG_ANA_QUICKEST ||
            _missionBackgroundSpecial == GUI_BACKGROUND_SPECIAL_LONG_ANA_SHORTEST)
    {
        return NSMakePoint(128.0, 128.0);
    }
    else if (_missionBackgroundSpecial == GUI_BACKGROUND_SPECIAL_CUSTOM ||
            _missionBackgroundSpecial == GUI_BACKGROUND_SPECIAL_CUSTOM_ANA_QUICKEST ||
            _missionBackgroundSpecial == GUI_BACKGROUND_SPECIAL_CUSTOM_ANA_SHORTEST)
    {
        return custom_chart_centre_coordinates;
    }
    // When fully zoomed in we want to centre chart on chart_centre_coordinates.  When zoomed out we want the chart centred on
    // (128.0, 128.0) so the galaxy fits the screen width.  For intermediate zoom we interpolate.
    acc.x = chart_centre_coordinates.x + (128.0 - chart_centre_coordinates.x) * (chart_zoom - 1.0) / (CHART_MAX_ZOOM - 1.0);
    acc.y = chart_centre_coordinates.y + (128.0 - chart_centre_coordinates.y) * (chart_zoom - 1.0) / (CHART_MAX_ZOOM - 1.0);
 
    // If the cursor is out of the centre non-scrolling part of the screen adjust the chart centre.  If the cursor is just at scroll_pos
    // we want to return the chart centre as it is, but if it's at the edge of the galaxy we want the centre positioned so the cursor is
    // at the edge of the screen
    if (chart_focus_coordinates.x - acc.x <= -CHART_SCROLL_AT_X*chart_zoom)
    {
        scroll_pos = acc.x - CHART_SCROLL_AT_X*chart_zoom;
        ecc = CHART_WIDTH_AT_MAX_ZOOM*chart_zoom / 2.0;
        if (scroll_pos <= 0)
        {
            acc.x = ecc;
        }
        else
        {
            acc.x = ((scroll_pos-chart_focus_coordinates.x)*ecc + chart_focus_coordinates.x*acc.x)/scroll_pos;
        }
    }
    else if (chart_focus_coordinates.x - acc.x >= CHART_SCROLL_AT_X*chart_zoom)
    {
        scroll_pos = acc.x + CHART_SCROLL_AT_X*chart_zoom;
        ecc = 256.0 - CHART_WIDTH_AT_MAX_ZOOM*chart_zoom / 2.0;
        if (scroll_pos >= 256.0)
        {
            acc.x = ecc;
        }
        else
        {
            acc.x = ((chart_focus_coordinates.x-scroll_pos)*ecc + (256.0 - chart_focus_coordinates.x)*acc.x)/(256.0 - scroll_pos);
        }
    }
    if (chart_focus_coordinates.y - acc.y <= -CHART_SCROLL_AT_Y*chart_zoom)
    {
        scroll_pos = acc.y - CHART_SCROLL_AT_Y*chart_zoom;
        ecc = CHART_HEIGHT_AT_MAX_ZOOM*chart_zoom / 2.0;
        if (scroll_pos <= 0)
        {
            acc.y = ecc;
        }
        else
        {
            acc.y = ((scroll_pos-chart_focus_coordinates.y)*ecc + chart_focus_coordinates.y*acc.y)/scroll_pos;
        }
    }
    else if (chart_focus_coordinates.y - acc.y >= CHART_SCROLL_AT_Y*chart_zoom)
    {
        scroll_pos = acc.y + CHART_SCROLL_AT_Y*chart_zoom;
        ecc = 256.0 - CHART_HEIGHT_AT_MAX_ZOOM*chart_zoom / 2.0;
        if (scroll_pos >= 256.0)
        {
            acc.y = ecc;
        }
        else
        {
            acc.y = ((chart_focus_coordinates.y-scroll_pos)*ecc + (256.0 - chart_focus_coordinates.y)*acc.y)/(256.0 - scroll_pos);
        }
    }
    return acc;
}

adjustPriceByScriptForEqKey:withCurrent:

- (OOCreditsQuantity) adjustPriceByScriptForEqKey:		(NSString *)	eqKey
withCurrent:		(OOCreditsQuantity)	price

Definition at line 9242 of file PlayerEntity.m.

                                                 :(NSString *)eqKey withCurrent:(OOCreditsQuantity)price
{
    NSString *condition_script = [[OOEquipmentType equipmentTypeWithIdentifier:eqKey] conditionScript];
    if (condition_script != nil)
    {
        OOJSScript *condScript = [UNIVERSE getConditionScript:condition_script];
        if (condScript != nil) // should always be non-nil, but just in case
        {
            JSContext           *JScontext = OOJSAcquireContext();
            BOOL OK;
            jsval result;
            int32 newPrice;
            jsval args[] = { OOJSValueFromNativeObject(JScontext, eqKey) , JSVAL_NULL };
            OK = JS_NewNumberValue(JScontext, price, &args[1]);
                
            if (OK)
            {
                OK = [condScript callMethod:OOJSID("updateEquipmentPrice")
                                  inContext:JScontext
                              withArguments:args count:sizeof args / sizeof *args
                                     result:&result];
            }
 
            if (OK)
            {
                OK = JS_ValueToInt32(JScontext, result, &newPrice);
                if (OK && newPrice >= 0)
                {
                    price = (OOCreditsQuantity)newPrice;
                }
            }
            OOJSRelinquishContext(JScontext);
        }
    }
    return price;
}

adjustTradeInFactorBy:

- (void) adjustTradeInFactorBy:

(int)

value

Definition at line 9242 of file PlayerEntity.m.

                              :(int)value
{
    ship_trade_in_factor += value;
    if (ship_trade_in_factor < 75)  ship_trade_in_factor = 75;
    if (ship_trade_in_factor > 100)  ship_trade_in_factor = 100;
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

aftShieldLevel

- (GLfloat) aftShieldLevel

Definition at line 13727 of file PlayerEntity.m.

{
    return aft_shield;
}

aftShieldRechargeRate

- (float) aftShieldRechargeRate

Definition at line 13727 of file PlayerEntity.m.

{
    return aft_shield_recharge_rate;
}

alertCondition

- (OOAlertCondition) alertCondition

Reimplemented from ShipEntity.

alertFlags

- (int) alertFlags

allowMissionInterrupt

- (void) allowMissionInterrupt

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    _missionAllowInterrupt = YES;
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

ANAMode

- (OORouteType) ANAMode

Definition at line 13727 of file PlayerEntity.m.

{
    return ANA_mode;
}

Referenced by PlayerShipGetProperty().

Here is the caller graph for this function:

applyAttitudeChanges:

- (void) applyAttitudeChanges: (double)  delta_t

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                             :(double) delta_t
{
    [self applyRoll:flightRoll*delta_t andClimb:flightPitch*delta_t];
    [self applyYaw:flightYaw*delta_t];
}

applyMarketFilter:onMarket:

- (NSArray *) applyMarketFilter:		(NSArray *)	goods
onMarket:		(OOCommodityMarket *)	market

Definition at line 9242 of file PlayerEntity.m.

                               :(NSArray *)goods onMarket:(OOCommodityMarket *)market
{
    if (marketFilterMode == MARKET_FILTER_MODE_OFF)
    {
        return goods;
    }
    NSMutableArray  *filteredGoods = [NSMutableArray arrayWithCapacity:[goods count]];
    OOCommodityType good = nil;
    foreach (good, goods)
    {
        switch (marketFilterMode)
        {
        case MARKET_FILTER_MODE_OFF:
            // never reached, but keeps compiler happy
            [filteredGoods addObject:good];
            break;
        case MARKET_FILTER_MODE_TRADE:
            if ([market quantityForGood:good] > 0 || [self cargoQuantityForType:good] > 0)
            {
                [filteredGoods addObject:good];
            }
            break;
        case MARKET_FILTER_MODE_HOLD:
            if ([self cargoQuantityForType:good] > 0)
            {
                [filteredGoods addObject:good];
            }
            break;
        case MARKET_FILTER_MODE_STOCK:
            if ([market quantityForGood:good] > 0)
            {
                [filteredGoods addObject:good];
            }
            break;
        case MARKET_FILTER_MODE_LEGAL:
            if ([market exportLegalityForGood:good] == 0 && [market importLegalityForGood:good] == 0)
            {
                [filteredGoods addObject:good];
            }
            break;
        case MARKET_FILTER_MODE_RESTRICTED:
            if ([market exportLegalityForGood:good] > 0 || [market importLegalityForGood:good] > 0)
            {
                [filteredGoods addObject:good];
            }
            break;
        }
    }
    return [[filteredGoods copy] autorelease];
}

applyMarketSorter:onMarket:

- (NSArray *) applyMarketSorter:		(NSArray *)	goods
onMarket:		(OOCommodityMarket *)	market

Definition at line 9242 of file PlayerEntity.m.

                               :(NSArray *)goods onMarket:(OOCommodityMarket *)market
{
    switch (marketSorterMode)
    {
    case MARKET_SORTER_MODE_ALPHA:
        return [goods sortedArrayUsingFunction:marketSorterByName context:market];
    case MARKET_SORTER_MODE_PRICE:
        return [goods sortedArrayUsingFunction:marketSorterByPrice context:market];
    case MARKET_SORTER_MODE_STOCK:
        return [goods sortedArrayUsingFunction:marketSorterByQuantity context:market];
    case MARKET_SORTER_MODE_HOLD:
        return [goods sortedArrayUsingFunction:marketSorterByQuantity context:shipCommodityData];
    case MARKET_SORTER_MODE_UNIT:
        return [goods sortedArrayUsingFunction:marketSorterByMassUnit context:market];  
    case MARKET_SORTER_MODE_OFF:
        // keep default sort order
        break;
    }
    return goods;
}

applyRoll:andClimb:

- (void) applyRoll: (GLfloat)  roll1 andClimb: (GLfloat)  climb1

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                  :(GLfloat) roll1 andClimb:(GLfloat) climb1
{
    if (roll1 == 0.0 && climb1 == 0.0 && hasRotated == NO)
        return;
 
    if (roll1)
        quaternion_rotate_about_z(&orientation, -roll1);
    if (climb1)
        quaternion_rotate_about_x(&orientation, -climb1);
    
    /*  Bugginess may put us in a state where the orientation quat is all
        zeros, at which point it’s impossible to move.
    */
    if (EXPECT_NOT(quaternion_equal(orientation, kZeroQuaternion)))
    {
        if (!quaternion_equal(lastOrientation, kZeroQuaternion))
        {
            orientation = lastOrientation;
        }
        else
        {
            orientation = kIdentityQuaternion;
        }
    }
    
    [self orientationChanged];
}

applyYaw:

- (void) applyYaw:

(GLfloat)

yaw

Definition at line 13727 of file PlayerEntity.m.

                 :(GLfloat) yaw
{
    quaternion_rotate_about_y(&orientation, -yaw);
    
    [self orientationChanged];
}

assignToActivePylon:

- (BOOL) assignToActivePylon:

(NSString *)

identifierKey

Definition at line 13727 of file PlayerEntity.m.

                            :(NSString *)equipmentKey
{
    if (!launchingMissile) return NO;
    
    OOEquipmentType         *eqType = nil;
    
    if ([equipmentKey hasSuffix:@"_DAMAGED"])
    {
        return NO;
    }
    else
    {
        eqType = [OOEquipmentType equipmentTypeWithIdentifier:equipmentKey];
    }
    
    // missiles with techlevel above 99 (kOOVariableTechLevel) are never available to the player
    if (![eqType isMissileOrMine] || [eqType effectiveTechLevel] > kOOVariableTechLevel)
    {
        return NO;
    }
 
    ShipEntity *amiss = [UNIVERSE newShipWithRole:equipmentKey];
    
    if (!amiss) return NO;
 
    // replace the missile now.
    [missile_entity[activeMissile] release];
    missile_entity[activeMissile] = amiss;
    missile_list[activeMissile] = eqType;
    
    // make sure the new missile is properly activated.
    if (activeMissile > 0) activeMissile--;
    else activeMissile = max_missiles - 1;
    [self selectNextMissile];
    
    replacingMissile = YES;
    
    return YES;
}

atHyperspeed

- (BOOL) atHyperspeed

Definition at line 13727 of file PlayerEntity.m.

{
    return travelling_at_hyperspeed;
}

autosavePlayer

- (void) autosavePlayer

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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];
}

availableFacings

- (OOWeaponFacingSet) availableFacings

Definition at line 9242 of file PlayerEntity.m.

{
    OOShipRegistry      *registry = [OOShipRegistry sharedRegistry];
    NSDictionary        *shipyardInfo = [registry shipyardInfoForKey:[self shipDataKey]];
    unsigned            available_facings = [shipyardInfo oo_unsignedIntForKey:KEY_WEAPON_FACINGS defaultValue:[self weaponFacings]];   // use defaults  explicitly
    
    return available_facings & VALID_WEAPON_FACINGS;
}

awardCargo:

- (void) awardCargo:

(NSString *)

amount_typeString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                   :(NSString *)amount_typeString
{
    if (scriptTarget != self)  return;
 
    NSArray                 *tokens = ScanTokensFromString(amount_typeString);
    OOCargoQuantityDelta    amount;
    OOCommodityType         type;
    OOMassUnit              unit;
 
    if ([tokens count] != 2)
    {
        OOLog(kOOLogSyntaxAwardCargo, @"***** SCRIPT ERROR: in %@, CANNOT awardCargo: '%@' (%@)", CurrentScriptDesc(), amount_typeString, @"bad parameter count");
        return;
    }
    
 
    type = [tokens oo_stringAtIndex:1];
    if (![[UNIVERSE commodities] goodDefined:type])
    {
        OOLog(kOOLogSyntaxAwardCargo, @"***** SCRIPT ERROR: in %@, CANNOT awardCargo: '%@' (%@)", CurrentScriptDesc(), amount_typeString, @"unknown type");
        return;
    }
    
    amount = [tokens oo_intAtIndex:0];
    if (amount < 0)
    {
        OOLog(kOOLogSyntaxAwardCargo, @"***** SCRIPT ERROR: in %@, CANNOT awardCargo: '%@' (%@)", CurrentScriptDesc(), amount_typeString, @"negative quantity");
        return;
    }
    
    unit = [shipCommodityData massUnitForGood:type];
    if (specialCargo && unit == UNITS_TONS)
    {
        OOLog(kOOLogSyntaxAwardCargo, @"***** SCRIPT ERROR: in %@, CANNOT awardCargo: '%@' (%@)", CurrentScriptDesc(), amount_typeString, @"cargo hold full with special cargo");
        return;
    }
    
    [self awardCommodityType:type amount:amount];
}

awardCommodityType:amount:

- (void) awardCommodityType:		(NSString *)	type
amount:		(OOCargoQuantity)	amount

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                           :(OOCommodityType)type amount:(OOCargoQuantity)amount
{
    OOMassUnit              unit;
 
    if (![[UNIVERSE commodities] goodDefined:type])
    {
        return;
    }
    
    OOLog(@"script.debug.note.awardCargo", @"Going to award cargo: %d x '%@'", amount, type);
    
    unit = [shipCommodityData massUnitForGood:type];
    
    if ([self status] != STATUS_DOCKED)
    {
        // in-flight
        while (amount)
        {
            if (unit != UNITS_TONS)
            {
                if (specialCargo)
                {
                    // is this correct behaviour?
                    [shipCommodityData addQuantity:amount forGood:type];
                }
                else
                {
                    int amount_per_container = (unit == UNITS_KILOGRAMS)? 1000 : 1000000;
                    while (amount > 0)
                    {
                        int smaller_quantity = 1 + ((amount - 1) % amount_per_container);
                        if ([cargo count] < [self maxAvailableCargoSpace])
                        {
                            ShipEntity* container = [UNIVERSE newShipWithRole:@"1t-cargopod"];
                            if (container)
                            {
                                // the cargopod ship is just being set up. If ejected,  will call UNIVERSE addEntity
                                // [container wasAddedToUniverse]; // seems to be not needed anymore for pods
                                [container setScanClass: CLASS_CARGO];
                                [container setStatus:STATUS_IN_HOLD];
                                [container setCommodity:type andAmount:smaller_quantity];
                                [cargo addObject:container];
                                [container release];
                            }
                        }
                        amount -= smaller_quantity;
                    }
                }
            }
            else if (!specialCargo)
            // no adding TCs while special cargo in hold
            {
                // put each ton in a separate container
                while (amount)
                {
                    if ([cargo count] < [self maxAvailableCargoSpace])
                    {
                        ShipEntity* container = [UNIVERSE newShipWithRole:@"1t-cargopod"];
                        if (container)
                        {
                            // the cargopod ship is just being set up. If ejected, will call UNIVERSE addEntity
                            // [container wasAddedToUniverse]; // seems to be not needed anymore for pods
                            [container setScanClass: CLASS_CARGO];
                            [container setStatus:STATUS_IN_HOLD];
                            [container setCommodity:type andAmount:1];
                            [cargo addObject:container];
                            [container release];
                        }
                    }
                    amount--;
                }
            }
        }
    }
    else
    {   // docked
        // like purchasing a commodity
        int manifest_quantity = [shipCommodityData quantityForGood:type];
        while ((amount)&&(current_cargo < [self maxAvailableCargoSpace]))
        {
            manifest_quantity++;
            amount--;
            if (unit == UNITS_TONS)  current_cargo++;
        }
        [shipCommodityData setQuantity:manifest_quantity forGood:type];
    }
    [self calculateCurrentCargo];
}

awardContract:commodity:start:destination:eta:fee:premium:

- (BOOL) awardContract:		(unsigned)	qty
commodity:		(NSString*)	commodity
start:		(unsigned)	start
destination:		(unsigned)	destination
eta:		(double)	eta
fee:		(double)	fee
premium:		(double)	premium

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                      :(unsigned)qty commodity:(OOCommodityType)type start:(unsigned)start
                     destination:(unsigned)Destination eta:(double)eta fee:(double)fee premium:(double)premium
{
 
    unsigned        sr1 = Ranrot()&0x111111;
    int             sr2 = Ranrot()&0x111111;
 
    NSString        *cargo_ID =[NSString stringWithFormat:@"%06x-%06x", sr1, sr2];
    
    if (![[UNIVERSE commodities] goodDefined:type])  return NO;
    if (qty < 1)  return NO;
    
    // avoid duplicate cargo_IDs
    while ([contract_record objectForKey:cargo_ID] != nil)
    {
        sr2++;
        cargo_ID =[NSString stringWithFormat:@"%06x-%06x", sr1, sr2];
    }
 
    NSDictionary* cargo_info = [NSDictionary dictionaryWithObjectsAndKeys:
        cargo_ID,                                       CARGO_KEY_ID,
        type,                                           CARGO_KEY_TYPE,
        [NSNumber numberWithInt:qty],                   CARGO_KEY_AMOUNT,
        [UNIVERSE describeCommodity:type amount:qty],   CARGO_KEY_DESCRIPTION,
        [NSNumber numberWithInt:start],                 CONTRACT_KEY_START,
        [NSNumber numberWithInt:Destination],           CONTRACT_KEY_DESTINATION,
        [NSNumber numberWithDouble:[PLAYER clockTime]], CONTRACT_KEY_DEPARTURE_TIME,
        [NSNumber numberWithDouble:eta],                CONTRACT_KEY_ARRIVAL_TIME,
        [NSNumber numberWithDouble:fee],                CONTRACT_KEY_FEE,
        [NSNumber numberWithDouble:premium],                        CONTRACT_KEY_PREMIUM,
        NULL];
    
    // check available space
    
    OOCargoQuantity     cargoSpaceRequired = qty;
    OOMassUnit          contractCargoUnits  = [shipCommodityData massUnitForGood:type];
    
    if (contractCargoUnits == UNITS_KILOGRAMS)  cargoSpaceRequired /= 1000;
    if (contractCargoUnits == UNITS_GRAMS)  cargoSpaceRequired /= 1000000;
    
    if (cargoSpaceRequired > [self availableCargoSpace]) return NO;
 
    [shipCommodityData addQuantity:qty forGood:type];
 
    current_cargo = [self cargoQuantityOnBoard];
 
    if ([shipCommodityData exportLegalityForGood:type] > 0)
    {
        [self addRoleToPlayer:@"trader-smuggler"];
        [roleWeightFlags setObject:[NSNumber numberWithInt:1] forKey:@"bought-illegal"];
    }
    else
    {
        [self addRoleToPlayer:@"trader"];
        [roleWeightFlags setObject:[NSNumber numberWithInt:1] forKey:@"bought-legal"];
    }
 
    [contracts addObject:cargo_info];
    [contract_record setObject:[NSNumber numberWithDouble:eta] forKey:cargo_ID];
 
    [self doScriptEvent:OOJSID("playerEnteredContract") withArguments:[NSArray arrayWithObjects:@"cargo",cargo_info,nil]];
 
    return YES;
}

Referenced by PlayerShipAwardContract().

Here is the caller graph for this function:

awardCredits:

- (void) awardCredits:

(NSString *)

valueString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                     :(NSString *)valueString
{
    if (scriptTarget != self)  return;
    
    /*  We can't use -longLongValue here for Mac OS X 10.4 compatibility, but
        we don't need to since larger values have never been supported for
        legacy scripts.
    */
    int64_t award = [valueString intValue];
    award *= 10;
    if (award < 0 && credits < (OOCreditsQuantity)-award)  credits = 0;
    else  credits += award;
}

awardEquipment:

- (void) awardEquipment:

(NSString *)

equipString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                       :(NSString *)equipString  //eg. EQ_NAVAL_ENERGY_UNIT
{
    if (scriptTarget != self)  return;
    
    if ([equipString isEqualToString:@"EQ_FUEL"])
    {
        [self setFuel:[self fuelCapacity]];
    }
    
    OOEquipmentType *eqType = [OOEquipmentType equipmentTypeWithIdentifier:equipString];
    
    if ([eqType isMissileOrMine])
    {
        [self mountMissileWithRole:equipString];
    }
    else if([equipString hasPrefix:@"EQ_WEAPON"] && ![equipString hasSuffix:@"_DAMAGED"])
    {
        OOLog(kOOLogSyntaxAwardEquipment, @"***** SCRIPT ERROR: in %@, CANNOT award undamaged weapon:'%@'. Damaged weapons can be awarded instead.", CurrentScriptDesc(), equipString);
    }
    else if ([equipString hasSuffix:@"_DAMAGED"] && [self hasEquipmentItem:[equipString substringToIndex:[equipString length] - [@"_DAMAGED" length]]])
    {
        OOLog(kOOLogSyntaxAwardEquipment, @"***** SCRIPT ERROR: in %@, CANNOT award damaged equipment:'%@'. Undamaged version already equipped.", CurrentScriptDesc(), equipString);
    }
    else if ([eqType canCarryMultiple] || ![self hasEquipmentItem:equipString])
    {
        [self addEquipmentItem:equipString withValidation:YES inContext:@"scripted"];
    }
}

awardFuel:

- (void) awardFuel:

(NSString *)

valueString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *)valueString  // add to fuel up to 7.0 LY
{
    int delta  = 10 * [valueString floatValue];
    OOFuelQuantity scriptTargetFuelBeforeAward = [scriptTarget fuel];
 
    if (delta < 0 && scriptTargetFuelBeforeAward < (unsigned)-delta)  [scriptTarget setFuel:0];
    else
    {
        [scriptTarget setFuel:(scriptTargetFuelBeforeAward + delta)];
    }
}

awardShipKills:

- (void) awardShipKills:

(NSString *)

valueString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                       :(NSString *)valueString
{
    if (scriptTarget != self)  return;
    
    int value = [valueString intValue];
    if (0 < value)  ship_kills += value;
}

baseMass

- (GLfloat) baseMass

Definition at line 13727 of file PlayerEntity.m.

{
    if (sBaseMass <= 0.0)
    {
        // First call with initialised mass (in [UNIVERSE setUpInitialUniverse]) is always to the cobra 3, even when starting with a savegame.
        if ([self mass] > 0.0)  // bootstrap the base mass.
        {
            OOLog(@"fuelPrices", @"Setting Cobra3 base mass to: %.2f ", [self mass]);
            sBaseMass = [self mass];
        }
        else 
        {
            // This happened on startup when [UNIVERSE setUpSpace] was called before player init, inside [UNIVERSE setUpInitialUniverse].
            OOLog(@"fuelPrices", @"%@", @"Player ship not initialised properly yet, using precalculated base mass.");
            return 185580.0;
        }
    }
 
    return sBaseMass;
}

beginWitchspaceCountdown

- (void) beginWitchspaceCountdown

Provided by category PlayerEntity(Controls).

Definition at line 164 of file PlayerEntityControls.m.

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

beginWitchspaceCountdown:

- (void) beginWitchspaceCountdown:

(int)

spin_time

Provided by category PlayerEntity(Controls).

Definition at line 164 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];
    }
}

Referenced by PlayerShipBeginHyperspaceCountdown().

Here is the caller graph for this function:

blowUpStation

- (void) blowUpStation

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    StationEntity       *mainStation = nil;
    
    mainStation = [UNIVERSE station];
    if (mainStation != nil)
    {
        [UNIVERSE unMagicMainStation];
        [mainStation takeEnergyDamage:500000000.0 from:nil becauseOf:nil weaponIdentifier:@""]; // 500 million should do it!
    }
}

boop

- (void) boop

implementation

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[general-boop]"];
}

bounty

- (OOCreditsQuantity) bounty

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    return legalStatus;
}

breakPatternPosition

- (HPVector) breakPatternPosition

Definition at line 13727 of file PlayerEntity.m.

{
    return HPvector_add(position,vectorToHPVector(quaternion_rotate_vector(quaternion_conjugate(orientation),forwardViewOffset)));
}

buySelectedItem

- (void) buySelectedItem

Definition at line 9242 of file PlayerEntity.m.

{
    GuiDisplayGen* gui = [UNIVERSE gui];
    NSString* key = [gui selectedRowKey];
 
    if ([key hasPrefix:@"More:"])
    {
        int         from_item = [[key componentsSeparatedByString:@":"] oo_intAtIndex:1];
        NSString    *weaponKey = [[key componentsSeparatedByString:@":"] oo_stringAtIndex:2];
 
        [self setGuiToEquipShipScreen:from_item];
        if (weaponKey != nil)
        {
            [self highlightEquipShipScreenKey:weaponKey];
        }
        else
        {
            if ([gui selectedRow] < 0)
                [gui setSelectedRow:GUI_ROW_EQUIPMENT_START];
            if (from_item == 0)
                [gui setSelectedRow:GUI_ROW_EQUIPMENT_START + GUI_MAX_ROWS_EQUIPMENT - 1];
            [self showInformationForSelectedUpgrade];
        }
 
        return;
    }
    
    NSString        *itemText = [gui selectedRowText];
    
    // FIXME: this is nuts, should be associating lines with keys in some sensible way. --Ahruman 20080311
    if ([itemText isEqual:FORWARD_FACING_STRING])
        chosen_weapon_facing = WEAPON_FACING_FORWARD;
    if ([itemText isEqual:AFT_FACING_STRING])
        chosen_weapon_facing = WEAPON_FACING_AFT;
    if ([itemText isEqual:PORT_FACING_STRING])
        chosen_weapon_facing = WEAPON_FACING_PORT;
    if ([itemText isEqual:STARBOARD_FACING_STRING])
        chosen_weapon_facing = WEAPON_FACING_STARBOARD;
    
    OOCreditsQuantity old_credits = credits;
    OOEquipmentType *eqInfo = [OOEquipmentType equipmentTypeWithIdentifier:key];
    BOOL isRepair = [self hasEquipmentItem:[eqInfo damagedIdentifier]];
    if ([self tryBuyingItem:key])
    {
        if (credits == old_credits)
        {
            // laser pre-purchase, or free equipment
            [self playMenuNavigationDown];
        }
        else
        {
            [self playBuyCommodity];
        }           
            
        if(credits != old_credits || ![key hasPrefix:@"EQ_WEAPON_"])
        {
            // adjust time before playerBoughtEquipment gets to change credits dynamically
            // wind the clock forward by 10 minutes plus 10 minutes for every 60 credits spent
            NSUInteger adjust = 0;
            if (isRepair)
            {
                adjust = [eqInfo repairTime];
            }
            else
            {
                adjust = [eqInfo installTime];
            }
            double time_adjust = (old_credits > credits) ? (old_credits - credits) : 0.0;
            [UNIVERSE forceWitchspaceEntries];
            if (adjust == 0)
            {
                ship_clock_adjust += time_adjust + 600.0;
            }
            else
            {
                ship_clock_adjust += (double)adjust;
            }
            
            [self doScriptEvent:OOJSID("playerBoughtEquipment") withArguments:[NSArray arrayWithObjects:key, [NSNumber numberWithLongLong:(old_credits - credits)], nil]];
            if (gui_screen == GUI_SCREEN_EQUIP_SHIP) //if we haven't changed gui screen inside playerBoughtEquipment
            { 
                // show any change due to playerBoughtEquipment
                [self setGuiToEquipShipScreen:0];
                // then try to go back where we were
                [self highlightEquipShipScreenKey:key];
            }
 
            if ([UNIVERSE autoSave]) [UNIVERSE setAutoSaveNow:YES];
        }
    }
    else
    {
        [self playCantBuyCommodity];
    }
}

buySelectedShip

- (BOOL) buySelectedShip

Provided by category PlayerEntity(Contracts).

Definition at line 1443 of file PlayerEntityContracts.m.

{
    GuiDisplayGen   *gui = [UNIVERSE gui];
    OOGUIRow        selectedRow = [gui selectedRow];
    
    if (selectedRow <= 0)  return NO;
    
    NSString *key = [gui keyForRow:selectedRow];
 
    if ([key hasPrefix:@"More:"])
    {
        NSInteger fromShip = [[key componentsSeparatedByString:@":"] oo_integerAtIndex:1];
        if (fromShip < 0)  fromShip = 0;
        
        [self setGuiToShipyardScreen:fromShip];
        if ([[UNIVERSE gui] selectedRow] < 0)
        {
            [[UNIVERSE gui] setSelectedRow:GUI_ROW_SHIPYARD_START];
        }
        if (fromShip == 0)
        {
            [[UNIVERSE gui] setSelectedRow:GUI_ROW_SHIPYARD_START + MAX_ROWS_SHIPS_FOR_SALE - 1];
        }
        // next bit or the first ship on the list gets wrongly previewed
        // clean up the display
        NSMutableArray *row_info = [NSMutableArray arrayWithArray:(NSArray*)[gui objectForRow:GUI_ROW_SHIPYARD_LABELS]];
        while ([row_info count] < 4)
        {
            [row_info addObject:@""];
        }
        [row_info replaceObjectAtIndex:2 withObject:@""];
        [row_info replaceObjectAtIndex:3 withObject:@""];
        NSUInteger      i;
        for (i = GUI_ROW_SHIPYARD_INFO_START; i < GUI_ROW_MARKET_CASH - 1; i++)
        {
            [gui setText:@"" forRow:i];
            [gui setColor:[gui colorFromSetting:kGuiShipyardDescriptionColor defaultValue:[OOColor greenColor]] forRow:i];
        }
        [gui setArray:[NSArray arrayWithArray:row_info] forRow:GUI_ROW_SHIPYARD_LABELS];
        [UNIVERSE removeDemoShips];
        return YES;
    }
 
    // first check you can afford it!
    NSDictionary *shipInfo = [currentShipyard oo_dictionaryForKey:key];
    OOCreditsQuantity price = [shipInfo oo_unsignedLongLongForKey:SHIPYARD_KEY_PRICE];
    OOCreditsQuantity tradeIn = [self tradeInValue];
 
    if (credits + tradeIn < price * 10)
        return NO;  // you can't afford it!
    
    // from this point, the player is committed to buying - raise a pre-buy script event
    [self doScriptEvent:OOJSID("playerWillBuyNewShip") 
        withArguments:[NSArray arrayWithObjects:[shipInfo oo_stringForKey:SHIPYARD_KEY_SHIPDATA_KEY], 
            [[[self dockedStation] localShipyard] objectAtIndex:selectedRow - GUI_ROW_SHIPYARD_START], 
            [NSNumber numberWithUnsignedLongLong:price], 
            [NSNumber numberWithUnsignedLongLong:(tradeIn / 10)], nil]];
 
    // sell all the commodities carried
    NSString *good = nil;
    foreach (good, [shipCommodityData goods])
    {
        [self trySellingCommodity:good all:YES];
    }
    // We tried to sell everything. If there are still items present in our inventory, it
    // means that the market got saturated (quantity in station > 127 t) before we could sell
    // it all. Everything that could not be sold will be lost. -- Nikos 20083012
 
    // pay over the mazoolah
    credits -= 10 * price - tradeIn;
    
    NSDictionary *shipDict = [shipInfo oo_dictionaryForKey:SHIPYARD_KEY_SHIP];
    [self newShipCommonSetup:[shipInfo oo_stringForKey:SHIPYARD_KEY_SHIPDATA_KEY] yardInfo:shipInfo baseInfo:shipDict];
 
    // this ship has a clean record
    legalStatus = 0;
 
    NSArray *extras = [shipInfo oo_arrayForKey:KEY_EQUIPMENT_EXTRAS];
    for (NSUInteger i = 0; i < [extras count]; i++)
    {
        NSString *eq_key = [extras oo_stringAtIndex:i];
        if ([eq_key isEqualToString:@"EQ_PASSENGER_BERTH"])
        {
            max_passengers++;
            max_cargo -= PASSENGER_BERTH_SPACE;
        }
        else
        {
            [self addEquipmentItem:eq_key withValidation:YES inContext:@"newShip"]; 
        }
    }
 
    // add bought ship to shipyard_record
    [shipyard_record setObject:[self shipDataKey] forKey:[shipInfo objectForKey:SHIPYARD_KEY_ID]];
    
    // remove the ship from the localShipyard
    [[[self dockedStation] localShipyard] removeObjectAtIndex:selectedRow - GUI_ROW_SHIPYARD_START];
    
    // perform the transformation
    NSDictionary* cmdr_dict = [self commanderDataDictionary];   // gather up all the info
    if (![self setCommanderDataFromDictionary:cmdr_dict])  return NO;
 
    [self setStatus:STATUS_DOCKED];
    [self setEntityPersonalityInt:[shipInfo oo_unsignedShortForKey:SHIPYARD_KEY_PERSONALITY]];
    
    // adjust the clock forward by an hour
    ship_clock_adjust += 3600.0;
    
    // finally we can get full hock if we sell it back
    ship_trade_in_factor = 100;
    
    if ([UNIVERSE autoSave])  [UNIVERSE setAutoSaveNow:YES];
    
    return YES;
}

calculateCurrentCargo

- (void) calculateCurrentCargo

Definition at line 9242 of file PlayerEntity.m.

{
    current_cargo = [self cargoQuantityOnBoard];
}

canAddEquipment:inContext:

- (BOOL) canAddEquipment: (NSString *)  equipmentKey inContext: (NSString *)  context

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                        :(NSString *)equipmentKey inContext:(NSString *)context
{
    if ([equipmentKey isEqualToString:@"EQ_RENOVATION"] && !(ship_trade_in_factor < 85 || [[[self shipSubEntityEnumerator] allObjects] count] < [self maxShipSubEntities]))  return NO;
    if (![super canAddEquipment:equipmentKey inContext:context])  return NO;
    
    NSArray *conditions = [[OOEquipmentType equipmentTypeWithIdentifier:equipmentKey] conditions];
    if (conditions != nil && ![self scriptTestConditions:conditions])  return NO;
    
    return YES;
}

cancelDockingRequest:

- (void) cancelDockingRequest:

(StationEntity *)

stationForDocking

Definition at line 13727 of file PlayerEntity.m.

                             :(StationEntity *)stationForDocking
{
    if (stationForDocking == nil) return;
    if (![stationForDocking isStation] || ![stationForDocking isKindOfClass:[StationEntity class]]) return;
    if ([self isDocked])  return;
    if (autopilot_engaged && [self targetStation] == stationForDocking) return;
    if (autopilot_engaged && [self targetStation] != stationForDocking)
    {
        [self disengageAutopilot];
    }
    if (dockingClearanceStatus == DOCKING_CLEARANCE_STATUS_GRANTED || dockingClearanceStatus == DOCKING_CLEARANCE_STATUS_REQUESTED)
    {
        NSString *stationDockingClearanceStatus = [stationForDocking acceptDockingClearanceRequestFrom:self];
        if (stationDockingClearanceStatus != nil && [stationDockingClearanceStatus isEqualToString:@"DOCKING_CLEARANCE_CANCELLED"])
        {
            [self doScriptEvent:OOJSID("playerDockingClearanceCancelled")];
        } 
    }
}

Referenced by PlayerShipCancelDockingRequest().

Here is the caller graph for this function:

cancelWitchspaceCountdown

- (void) cancelWitchspaceCountdown

Provided by category PlayerEntity(Controls).

Definition at line 164 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")];
}

Referenced by PlayerShipCancelHyperspaceCountdown().

Here is the caller graph for this function:

canCollide

- (BOOL) canCollide

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    switch ([self status])
    {
        case STATUS_START_GAME:
        case STATUS_DOCKING:
        case STATUS_DOCKED:
        case STATUS_DEAD:
        case STATUS_ESCAPE_SEQUENCE:
            return NO;
        
        default:
            return YES;
    }
}

canScoop:

- (BOOL) canScoop: (ShipEntity *)  other

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                 :(ShipEntity *)other
{
    if (specialCargo)   return NO;
    return [super canScoop:other];
}

cargoContractMarker:

- (NSDictionary *) cargoContractMarker:

(OOSystemID)

system

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                      :(OOSystemID)system
{
    return [[[NSDictionary dictionaryWithObjectsAndKeys:
                                [NSNumber numberWithInt:system], @"system",
                                MISSION_DEST_LEGACY, @"name",
                                @"orangeColor", @"markerColor",
                                @"MARKER_SQUARE", @"markerShape",
                                nil] retain] autorelease];
}

cargoList

- (NSArray *) cargoList

Definition at line 13727 of file PlayerEntity.m.

{
    NSMutableArray  *manifest = [NSMutableArray array];
    NSArray         *list = [self cargoListForScripting];
    NSDictionary    *commodity;
    
    if (specialCargo) [manifest addObject:specialCargo];
    
    foreach (commodity, list)
    {
        NSInteger quantity = [commodity oo_integerForKey:@"quantity"];
        NSString *units = [commodity oo_stringForKey:@"unit"];
        NSString *commodityName = [commodity oo_stringForKey:@"displayName"];
        NSInteger containers = [commodity oo_intForKey:@"containers"];
        BOOL extended = ![units isEqualToString:DESC(@"cargo-tons-symbol")] && containers > 0;
 
        if (extended) {
            [manifest addObject:OOExpandKey(@"manifest-cargo-quantity-extended", quantity, units, commodityName, containers)];
        } else {
            [manifest addObject:OOExpandKey(@"manifest-cargo-quantity", quantity, units, commodityName)];
        }
    }
    
    return manifest;
}

cargoListForScripting

- (NSArray *) cargoListForScripting

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    NSMutableArray      *list = [NSMutableArray array];
    
    NSUInteger          i, j, commodityCount = [shipCommodityData count];
    OOCargoQuantity     quantityInHold[commodityCount];
    OOCargoQuantity     containersInHold[commodityCount];
    NSArray             *goods = [shipCommodityData goods];
 
    // following changed to work whether docked or not
    for (i = 0; i < commodityCount; i++)
    {
        quantityInHold[i] = [shipCommodityData quantityForGood:[goods oo_stringAtIndex:i]];
        containersInHold[i] = 0;
    }
    for (i = 0; i < [cargo count]; i++)
    {
        ShipEntity *container = [cargo objectAtIndex:i];
        j = [goods indexOfObject:[container commodityType]];
        quantityInHold[j] += [container commodityAmount];
        ++containersInHold[j];
    }
    
    for (i = 0; i < commodityCount; i++)
    {
        if (quantityInHold[i] > 0)
        {
            NSMutableDictionary *commodity = [NSMutableDictionary dictionaryWithCapacity:4];
            NSString *symName = [goods oo_stringAtIndex:i];
            // commodity, quantity - keep consistency between .manifest and .contracts
            [commodity setObject:symName forKey:@"commodity"];
            [commodity setObject:[NSNumber numberWithUnsignedInt:quantityInHold[i]] forKey:@"quantity"];
            [commodity setObject:[NSNumber numberWithUnsignedInt:containersInHold[i]] forKey:@"containers"];
            [commodity setObject:[shipCommodityData nameForGood:symName] forKey:@"displayName"]; 
            [commodity setObject:DisplayStringForMassUnitForCommodity(symName) forKey:@"unit"]; 
            [list addObject:commodity];
        }
    }
 
    return [[list copy] autorelease];   // return an immutable copy
}

Referenced by ManifestGetProperty().

Here is the caller graph for this function:

cargoQuantityForType:

- (OOCargoQuantity) cargoQuantityForType:

(OOCommodityType)

type

Definition at line 9242 of file PlayerEntity.m.

                                        :(OOCommodityType)type
{
    OOCargoQuantity     amount = [shipCommodityData quantityForGood:type];
    
    if  ([self status] != STATUS_DOCKED)
    {
        NSInteger       i;
        OOCommodityType co_type;
        ShipEntity      *cargoItem = nil;
        
        for (i = [cargo count] - 1; i >= 0 ; i--)
        {
            cargoItem = [cargo objectAtIndex:i];
            co_type = [cargoItem commodityType];
            if ([co_type isEqualToString:type])
            {
                amount += [cargoItem commodityAmount];
            }
        }
    }
    
    return amount;
}

cargoQuantityOnBoard

- (OOCargoQuantity) cargoQuantityOnBoard

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

{
    if ([self specialCargo] != nil)
    {
        return [self maxAvailableCargoSpace];
    }   
    
    /*
        The cargo array is nil when the player ship is docked, due to action in unloadCargopods. For
        this reason, we must use a slightly more complex method to determine the quantity of cargo
        carried in this case - Nikos 20090830
        
        Optimised this method, to compensate for increased usage - Kaks 20091002
    */
    OOCargoQuantity     cargoQtyOnBoard = 0;
    NSString            *good = nil;
 
    foreach (good, [shipCommodityData goods])
    {
        OOCargoQuantity quantity = [shipCommodityData quantityForGood:good];
        
        OOMassUnit commodityUnits = [shipCommodityData massUnitForGood:good];
        
        if (commodityUnits != UNITS_TONS)
        {
            // calculate the number of pods that would be used
            // we're using integer math, so 99/100 = 0 ,  100/100 = 1, etc...
            
            assert(KILOGRAMS_PER_POD > MAX_KILOGRAMS_IN_SAFE && GRAMS_PER_POD > MAX_GRAMS_IN_SAFE); // otherwise we're in trouble!
            
            if (commodityUnits == UNITS_KILOGRAMS)  quantity = ((KILOGRAMS_PER_POD - MAX_KILOGRAMS_IN_SAFE - 1) + quantity) / KILOGRAMS_PER_POD;
            else  quantity = ((GRAMS_PER_POD - MAX_GRAMS_IN_SAFE - 1) + quantity) / GRAMS_PER_POD;
        }
        cargoQtyOnBoard += quantity;
    }
    cargoQtyOnBoard += [[self cargo] count];
    
    return cargoQtyOnBoard;
}

changePassengerBerths:

- (BOOL) changePassengerBerths:

(int)

addRemove

Definition at line 9242 of file PlayerEntity.m.

                              :(int) addRemove
{
    if (addRemove == 0) return NO;
    addRemove = (addRemove > 0) ? 1 : -1;   // change only by one berth at a time!
    // NSFO!
    //unsigned  passenger_space = [[OOEquipmentType equipmentTypeWithIdentifier:@"EQ_PASSENGER_BERTH"] requiredCargoSpace];
    //if (passenger_space == 0) passenger_space = PASSENGER_BERTH_SPACE;
    if ((max_passengers < 1 && addRemove == -1) || ([self maxAvailableCargoSpace] - current_cargo < PASSENGER_BERTH_SPACE && addRemove == 1)) return NO;
    max_passengers += addRemove;
    max_cargo -= PASSENGER_BERTH_SPACE * addRemove;
    return YES;
}

Referenced by ShipAwardEquipment().

Here is the caller graph for this function:

chart_centre_coordinates

- (NSPoint) chart_centre_coordinates

chart_zoom

- (OOScalar) chart_zoom

checkCustomEquipButtons:ignore:

- (void) checkCustomEquipButtons: (NSDictionary *)  stickFn ignore: (int)  idx

implementation

Provided by category PlayerEntity(StickMapperInternal).

Definition at line 1 of file PlayerEntityStickMapper.m.

                                :(NSDictionary *)stickFn ignore:(int)idx
{
    int i;
    for (i = 0; i < [customEquipActivation count]; i++)
    {
        if (i != idx) {
            NSMutableDictionary *custEquip = [[customEquipActivation objectAtIndex:i] mutableCopy];
            NSDictionary *bf = [[customEquipActivation objectAtIndex:i] objectForKey:CUSTOMEQUIP_BUTTONACTIVATE];
            if ([bf oo_integerForKey:STICK_NUMBER] == [stickFn oo_integerForKey:STICK_NUMBER] && 
                [bf oo_integerForKey:STICK_AXBUT] == [stickFn oo_integerForKey:STICK_AXBUT] &&
                [custEquip objectForKey:CUSTOMEQUIP_BUTTONACTIVATE])
            {
                [custEquip removeObjectForKey:CUSTOMEQUIP_BUTTONACTIVATE];
            }
            bf = [[customEquipActivation objectAtIndex:i] objectForKey:CUSTOMEQUIP_BUTTONMODE];
            if ([bf oo_integerForKey:STICK_NUMBER] == [stickFn oo_integerForKey:STICK_NUMBER] && 
                [bf oo_integerForKey:STICK_AXBUT] == [stickFn oo_integerForKey:STICK_AXBUT] &&
                [custEquip objectForKey:CUSTOMEQUIP_BUTTONMODE])
            {
                [custEquip removeObjectForKey:CUSTOMEQUIP_BUTTONMODE];
            }
            [customEquipActivation replaceObjectAtIndex:i withObject:custEquip];
            [custEquip release];
        }
    }
}

checkEntityForMassLock:withScanClass:

- (BOOL) checkEntityForMassLock: (Entity *)  ent withScanClass: (int)  theirClass

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                               :(Entity *)ent withScanClass:(int)theirClass
{
    BOOL massLocked = NO;
    BOOL entIsCloakedShip = [ent isShip] && [(ShipEntity *)ent isCloaked];
    
    if (EXPECT_NOT([ent isStellarObject]))
    {
        Entity<OOStellarBody> *stellar = (Entity<OOStellarBody> *)ent;
        if (EXPECT([stellar planetType] != STELLAR_TYPE_MINIATURE))
        {
            double dist = stellar->zero_distance;
            double rad = stellar->collision_radius;
            double factor = ([stellar isSun]) ? 2.0 : 4.0;
            // plus ensure mass lock when 25 km or less from the surface of small stellar bodies
            // dist is a square distance so it needs to be compared to (rad+25000) * (rad+25000)!
            if (dist < rad*rad*factor || dist < rad*rad + 50000*rad + 625000000 ) 
            {
                massLocked = YES;
            }
        }
    }
    else if (theirClass != CLASS_NO_DRAW)
    {
        if (EXPECT_NOT (entIsCloakedShip))
        {
            theirClass = CLASS_NO_DRAW;
        }
    }
 
    if (!massLocked && ent->zero_distance <= SCANNER_MAX_RANGE2)
    {
        switch (theirClass)
        {
            case CLASS_NO_DRAW:
                // cloaked ships do mass lock! - Nikos 20200718
                if (entIsCloakedShip && ![ent isPlayer])
                {
                    massLocked = YES;
                }
                break;
            case CLASS_PLAYER:
            case CLASS_BUOY:
            case CLASS_ROCK:
            case CLASS_CARGO:
            case CLASS_MINE:
            case CLASS_VISUAL_EFFECT:
                break;
                
            case CLASS_THARGOID:
            case CLASS_MISSILE:
            case CLASS_STATION:
            case CLASS_POLICE:
            case CLASS_MILITARY:
            case CLASS_WORMHOLE:
            default:
                massLocked = YES;
                break;
        }
    }
    
    return massLocked;
}

checkForShips:

- (void) checkForShips:

(NSString *)

roleString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                      :(NSString *)roleString
{
    shipsFound = [UNIVERSE countShipsWithPrimaryRole:roleString];
}

checkKeyPress:

- (BOOL) checkKeyPress:

(NSArray*)

key_def

Provided by category PlayerEntity(Controls).

Definition at line 164 of file PlayerEntityControls.m.

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

Referenced by PlayerEntity(OOControlsPrivate)::handleAutopilotOn:.

Here is the caller graph for this function:

checkKeyPress:fKey_only:

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

Provided by category PlayerEntity(Controls).

Definition at line 164 of file PlayerEntityControls.m.

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

checkKeyPress:fKey_only:ignore_ctrl:

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

Provided by category PlayerEntity(Controls).

Definition at line 164 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;
}

checkKeyPress:ignore_ctrl:

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

Provided by category PlayerEntity(Controls).

Definition at line 164 of file PlayerEntityControls.m.

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

checkNavKeyPress:

- (BOOL) checkNavKeyPress:

(NSArray*)

key_def

Provided by category PlayerEntity(Controls).

Definition at line 164 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;
}

checkPassengerContracts

- (NSString *) checkPassengerContracts

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    if ([self dockedStation] != [UNIVERSE station]) // only drop off passengers or fulfil contracts at main station
        return nil;
    
    // check escape pods...
    // TODO
    
    NSMutableString     *result = [NSMutableString string];
    unsigned            i;
    
    // check passenger contracts
    for (i = 0; i < [passengers count]; i++)
    {
        NSDictionary* passenger_info = [[passengers oo_dictionaryAtIndex:i] retain];
        NSString* passenger_name = [passenger_info oo_stringForKey:PASSENGER_KEY_NAME];
        int dest = [passenger_info oo_intForKey:CONTRACT_KEY_DESTINATION];
        // the system name can change via script
        NSString* passenger_dest_name = [UNIVERSE getSystemName: dest];
        int dest_eta = [passenger_info oo_doubleForKey:CONTRACT_KEY_ARRIVAL_TIME] - ship_clock;
        
        if (system_id == dest)
        {
            // we've arrived in system!
            if (dest_eta > 0)
            {
                // and in good time
                long long fee = [passenger_info oo_longLongForKey:CONTRACT_KEY_FEE];
                while ((randf() < 0.75)&&(dest_eta > 3600)) // delivered with more than an hour to spare and a decent customer?
                {
                    fee *= 110; // tip + 10%
                    fee /= 100;
                    dest_eta *= 0.5;
                }
                credits += 10 * fee;
                
                [result appendFormatLine:DESC(@"passenger-delivered-okay-@-@-@"), passenger_name, OOIntCredits(fee), passenger_dest_name];
                if ([passenger_info oo_unsignedIntForKey:CONTRACT_KEY_RISK defaultValue:0] > 0)
                {
                    [self addRoleToPlayer:@"trader-courier+"];
                }
 
                [self increasePassengerReputation:RepForRisk([passenger_info oo_unsignedIntForKey:CONTRACT_KEY_RISK defaultValue:0])];
                [passengers removeObjectAtIndex:i--];
                [self doScriptEvent:OOJSID("playerCompletedContract") withArguments:[NSArray arrayWithObjects:@"passenger",@"success",[NSNumber numberWithUnsignedInteger:(10*fee)],passenger_info,nil]];
            }
            else
            {
                // but we're late!
                long long fee = [passenger_info oo_longLongForKey:CONTRACT_KEY_FEE] / 2;    // halve fare
                while (randf() < 0.5)   // maybe halve fare a few times!
                    fee /= 2;
                credits += 10 * fee;
                
                [result appendFormatLine:DESC(@"passenger-delivered-late-@-@-@"), passenger_name, OOIntCredits(fee), passenger_dest_name];
                if ([passenger_info oo_unsignedIntForKey:CONTRACT_KEY_RISK defaultValue:0] > 0)
                {
                    [self addRoleToPlayer:@"trader-courier+"];
                }
 
                [passengers removeObjectAtIndex:i--];
                [self doScriptEvent:OOJSID("playerCompletedContract") withArguments:[NSArray arrayWithObjects:@"passenger",@"late",[NSNumber numberWithUnsignedInteger:10*fee],passenger_info,nil]];
 
            }
        }
        else
        {
            if (dest_eta < 0)
            {
                // we've run out of time!
                [result appendFormatLine:DESC(@"passenger-failed-@"), passenger_name];
                
                [self decreasePassengerReputation:RepForRisk([passenger_info oo_unsignedIntForKey:CONTRACT_KEY_RISK defaultValue:0])];
                [passengers removeObjectAtIndex:i--];
                [self doScriptEvent:OOJSID("playerCompletedContract") withArguments:[NSArray arrayWithObjects:@"passenger",@"failed",[NSNumber numberWithUnsignedInteger:0],passenger_info,nil]];
            }
        }
        [passenger_info release];
    }
 
    // check parcel contracts
    for (i = 0; i < [parcels count]; i++)
    {
        NSDictionary* parcel_info = [[parcels oo_dictionaryAtIndex:i] retain];
        NSString* parcel_name = [parcel_info oo_stringForKey:PASSENGER_KEY_NAME];
        int dest = [parcel_info oo_intForKey:CONTRACT_KEY_DESTINATION];
        int dest_eta = [parcel_info oo_doubleForKey:CONTRACT_KEY_ARRIVAL_TIME] - ship_clock;
        
        if (system_id == dest)
        {
            // we've arrived in system!
            if (dest_eta > 0)
            {
                // and in good time
                long long fee = [parcel_info oo_longLongForKey:CONTRACT_KEY_FEE];
                while ((randf() < 0.75)&&(dest_eta > 86400))    // delivered with more than a day to spare and a decent customer?
                {
                    // lower tips than passengers
                    fee *= 110; // tip + 10%
                    fee /= 100;
                    dest_eta *= 0.5;
                }
                credits += 10 * fee;
                
                [result appendFormatLine:DESC(@"parcel-delivered-okay-@-@"), parcel_name, OOIntCredits(fee)];
                
                [self increaseParcelReputation:RepForRisk([parcel_info oo_unsignedIntForKey:CONTRACT_KEY_RISK defaultValue:0])];
 
                [parcels removeObjectAtIndex:i--];
                if ([parcel_info oo_unsignedIntForKey:CONTRACT_KEY_RISK defaultValue:0] > 0)
                {
                    [self addRoleToPlayer:@"trader-courier+"];
                }
                [self doScriptEvent:OOJSID("playerCompletedContract") withArguments:[NSArray arrayWithObjects:@"parcel",@"success",[NSNumber numberWithUnsignedInteger:10*fee],parcel_info,nil]];
 
            }
            else
            {
                // but we're late!
                long long fee = [parcel_info oo_longLongForKey:CONTRACT_KEY_FEE] / 2;   // halve fare
                while (randf() < 0.5)   // maybe halve fare a few times!
                    fee /= 2;
                credits += 10 * fee;
                
                [result appendFormatLine:DESC(@"parcel-delivered-late-@-@"), parcel_name, OOIntCredits(fee)];
                if ([parcel_info oo_unsignedIntForKey:CONTRACT_KEY_RISK defaultValue:0] > 0)
                {
                    [self addRoleToPlayer:@"trader-courier+"];
                }
                [parcels removeObjectAtIndex:i--];
                [self doScriptEvent:OOJSID("playerCompletedContract") withArguments:[NSArray arrayWithObjects:@"parcel",@"late",[NSNumber numberWithUnsignedInteger:10*fee],parcel_info,nil]];
            }
        }
        else
        {
            if (dest_eta < 0)
            {
                // we've run out of time!
                [result appendFormatLine:DESC(@"parcel-failed-@"), parcel_name];
                
                [self decreaseParcelReputation:RepForRisk([parcel_info oo_unsignedIntForKey:CONTRACT_KEY_RISK defaultValue:0])];
                [parcels removeObjectAtIndex:i--];
                [self doScriptEvent:OOJSID("playerCompletedContract") withArguments:[NSArray arrayWithObjects:@"parcel",@"failed",[NSNumber numberWithUnsignedInteger:0],parcel_info,nil]];
            }
        }
        [parcel_info release];
    }
 
    
    // check cargo contracts
    for (i = 0; i < [contracts count]; i++)
    {
        NSDictionary* contract_info = [[contracts oo_dictionaryAtIndex:i] retain];
        NSString* contract_cargo_desc = [contract_info oo_stringForKey:CARGO_KEY_DESCRIPTION];
        int dest = [contract_info oo_intForKey:CONTRACT_KEY_DESTINATION];
        int dest_eta = [contract_info oo_doubleForKey:CONTRACT_KEY_ARRIVAL_TIME] - ship_clock;
        
        if (system_id == dest)
        {
            // no longer needed
            // int premium = 10 * [contract_info oo_floatForKey:CONTRACT_KEY_PREMIUM];
            int fee = 10 * [contract_info oo_floatForKey:CONTRACT_KEY_FEE];
            
            OOCommodityType contract_cargo_type = [contract_info oo_stringForKey:CARGO_KEY_TYPE];
            int contract_amount = [contract_info oo_intForKey:CARGO_KEY_AMOUNT];
            
            int quantity_on_hand =  [shipCommodityData quantityForGood:contract_cargo_type];
 
            // we've arrived in system!
            if (dest_eta > 0)
            {
                // and in good time
                if (quantity_on_hand >= contract_amount)
                {
                    // with the goods too!
                    
                    // remove the goods...
                    [shipCommodityData removeQuantity:contract_amount forGood:contract_cargo_type];
 
                    // pay the premium and fee
                    // credits += fee + premium;
                    // not any more: all contracts initially awarded by JS, so fee
                    // is now all that needs to be paid - CIM
 
                    if ([shipCommodityData exportLegalityForGood:contract_cargo_type] > 0)
                    {
                        [self addRoleToPlayer:@"trader-smuggler"];
                    }
                    else
                    {
                        [self addRoleToPlayer:@"trader"];
                    }
                    
                    credits += fee;
                    [result appendFormatLine:DESC(@"cargo-delivered-okay-@-@"), contract_cargo_desc, OOCredits(fee)];
                    
                    [contracts removeObjectAtIndex:i--];
                    // repute++
                    // +10 as cargo contracts don't have risk modifiers
                    [self increaseContractReputation:10];
                    [self doScriptEvent:OOJSID("playerCompletedContract") withArguments:[NSArray arrayWithObjects:@"cargo",@"success",[NSNumber numberWithUnsignedInteger:fee],contract_info,nil]];
 
                }
                else
                {
                    // see if the amount of goods delivered is acceptable
                    
                    float percent_delivered = 100.0 * (float)quantity_on_hand/(float)contract_amount;
                    float acceptable_ratio = 100.0 - 10.0 * system_id / 256.0; // down to 90%
                    
                    if (percent_delivered >= acceptable_ratio)
                    {
                        // remove the goods...
                        [shipCommodityData setQuantity:0 forGood:contract_cargo_type];
 
                        // pay the fee
                        int shortfall = 100 - percent_delivered;
                        int payment = percent_delivered * (fee) / 100.0;
                        credits += payment;
                        
                        if ([shipCommodityData exportLegalityForGood:contract_cargo_type] > 0)
                        {
                            [self addRoleToPlayer:@"trader-smuggler"];
                        }
                        else
                        {
                            [self addRoleToPlayer:@"trader"];
                        }
 
                        [result appendFormatLine:DESC(@"cargo-delivered-short-@-@-d"), contract_cargo_desc, OOCredits(payment), shortfall];
                        
                        [contracts removeObjectAtIndex:i--];
                        // repute unchanged
                        [self doScriptEvent:OOJSID("playerCompletedContract") withArguments:[NSArray arrayWithObjects:@"cargo",@"short",[NSNumber numberWithUnsignedInteger:payment],contract_info,nil]];
 
                    }
                    else
                    {
                        [result appendFormatLine:DESC(@"cargo-refused-short-%@"), contract_cargo_desc];
                        // The player has still time to buy the missing goods elsewhere and fulfil the contract.
                    }
                }
            }
            else
            {
                // but we're late!
                [result appendFormatLine:DESC(@"cargo-delivered-late-@"), contract_cargo_desc];
 
                [contracts removeObjectAtIndex:i--];
                // repute--
                [self decreaseContractReputation:10];
                [self doScriptEvent:OOJSID("playerCompletedContract") withArguments:[NSArray arrayWithObjects:@"cargo",@"late",[NSNumber numberWithUnsignedInteger:0],contract_info,nil]];
            }
        }
        else
        {
            if (dest_eta < 0)
            {
                // we've run out of time!
                [result appendFormatLine:DESC(@"cargo-failed-@"), contract_cargo_desc];
                
                [contracts removeObjectAtIndex:i--];
                // repute--
                [self decreaseContractReputation:10];
                [self doScriptEvent:OOJSID("playerCompletedContract") withArguments:[NSArray arrayWithObjects:@"cargo",@"failed",[NSNumber numberWithUnsignedInteger:0],contract_info,nil]];
            }
        }
        [contract_info release];
    }
    
    // check passenger_record for expired contracts
    NSArray* names = [passenger_record allKeys];
    for (i = 0; i < [names count]; i++)
    {
        double dest_eta = [passenger_record oo_doubleForKey:[names objectAtIndex:i]] - ship_clock;
        if (dest_eta < 0)
        {
            // check they're not STILL on board
            BOOL on_board = NO;
            unsigned j;
            for (j = 0; j < [passengers count]; j++)
            {
                NSDictionary* passenger_info = [passengers oo_dictionaryAtIndex:j];
                if ([[passenger_info objectForKey:PASSENGER_KEY_NAME] isEqual:[names objectAtIndex:i]])
                    on_board = YES;
            }
            if (!on_board)
            {
                [passenger_record removeObjectForKey:[names objectAtIndex:i]];
            }
        }
    }
    
    // check contract_record for expired contracts
    NSArray* ids = [contract_record allKeys];
    for (i = 0; i < [ids count]; i++)
    {
        double dest_eta = [(NSNumber*)[contract_record objectForKey:[ids objectAtIndex:i]] doubleValue] - ship_clock;
        if (dest_eta < 0)
        {
            [contract_record removeObjectForKey:[ids objectAtIndex:i]];
        }
    }
 
    // check parcel_record for expired deliveries
    ids = [parcel_record allKeys];
    for (i = 0; i < [ids count]; i++)
    {
        double dest_eta = [(NSNumber*)[parcel_record objectForKey:[ids objectAtIndex:i]] doubleValue] - ship_clock;
        if (dest_eta < 0)
        {
            [parcel_record removeObjectForKey:[ids objectAtIndex:i]];
        }
    }
 
    
    if ([result length] == 0)
    {
        result = nil;
    }
    else
    {
        // Should have a trailing \n
        [result deleteCharacterAtIndex:[result length] - 1];
    }
    
    return result;
}

checkScript

- (void) checkScript

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    BOOL                        wasRunningScript = sRunningScript;
    OOEntityStatus              status, restoreStatus;
    
    NSDictionary *tickleScripts = [self worldScriptsRequiringTickle];
    if ([tickleScripts count] == 0)
    {
        // Quick exit if we only have JS scripts.
        return;
    }
    
    [self setScriptTarget:self];
    
    /*  World scripts can potentially be invoked recursively, through
        scriptActionOnTarget: and possibly other mechanisms. This is bad, but
        that's the way it is. Legacy world scripts rely on only seeing certain
        player statuses once per "event". To ensure this, we must lie about
        the player's status when invoked recursively.
        
        Of course, there are also methods in the game that rely on status not
        lying. However, I don't believe any that rely on these particular
        statuses can be legitimately invoked by scripts. The alternative would
        be to track the "status-as-seen-by-scripts" separately from the "real"
        status, which'd risk synchronization problems.
        
        In summary, scriptActionOnTarget: is bad, and calling it from scripts
        rather than AIs is very bad.
        -- Ahruman, 20080302
        
        Addendum: scriptActionOnTarget: is currently not in the whitelist for
        script methods. Let's hope this doesn't turn out to be a problem.
        -- Ahruman, 20090208
    */
    status = [self status];
    restoreStatus = status;
    @try
    {
        if (sRunningScript)
        {
            status = RecursiveRemapStatus(status);
            [self setStatus:status];
        }
        sRunningScript = YES;
        
        // After all that, actually running the scripts is trivial.
        [[tickleScripts allValues] makeObjectsPerformSelector:@selector(runWithTarget:) withObject:self];
    }
    @catch (NSException *exception)
    {
        OOLog(kOOLogException, @"***** Exception running world scripts: %@ : %@", [exception name], [exception reason]);
    }
    
    // Restore anti-recursion measures.
    sRunningScript = wasRunningScript;
    if (status != restoreStatus)  [self setStatus:restoreStatus];
}

checkScriptsIfAppropriate

- (void) checkScriptsIfAppropriate

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    if (script_time <= script_time_check)  return;
    
    if ([self status] != STATUS_IN_FLIGHT)
    {
        switch (gui_screen)
        {
            // Screens where no world script tickles are performed
            case GUI_SCREEN_MAIN:
            case GUI_SCREEN_INTRO1:
            case GUI_SCREEN_SHIPLIBRARY:
            case GUI_SCREEN_KEYBOARD:
            case GUI_SCREEN_NEWGAME:
            case GUI_SCREEN_OXZMANAGER:
            case GUI_SCREEN_MARKET:
            case GUI_SCREEN_MARKETINFO:
            case GUI_SCREEN_OPTIONS:
            case GUI_SCREEN_GAMEOPTIONS:
            case GUI_SCREEN_LOAD:
            case GUI_SCREEN_SAVE:
            case GUI_SCREEN_SAVE_OVERWRITE:
            case GUI_SCREEN_STICKMAPPER:
            case GUI_SCREEN_STICKPROFILE:
            case GUI_SCREEN_MISSION:
            case GUI_SCREEN_REPORT:
            case GUI_SCREEN_KEYBOARD_CONFIRMCLEAR:
            case GUI_SCREEN_KEYBOARD_CONFIG:
            case GUI_SCREEN_KEYBOARD_ENTRY:
            case GUI_SCREEN_KEYBOARD_LAYOUT:
                return;
            
            // Screens from which it's safe to jump to the mission screen
//          case GUI_SCREEN_CONTRACTS:
            case GUI_SCREEN_EQUIP_SHIP:
            case GUI_SCREEN_INTERFACES:
            case GUI_SCREEN_MANIFEST:
            case GUI_SCREEN_SHIPYARD:
            case GUI_SCREEN_LONG_RANGE_CHART:
            case GUI_SCREEN_SHORT_RANGE_CHART:
            case GUI_SCREEN_STATUS:
            case GUI_SCREEN_SYSTEM_DATA:
                // Test passed, we can run scripts. Nothing to do here.
                break;
        }
    }
    
    // Test either passed or never ran, run scripts.
    [self checkScript];
    script_time_check += script_time_interval;
}

clearAlertFlags

- (void) clearAlertFlags

Definition at line 13727 of file PlayerEntity.m.

{
    alertFlags = 0;
}

clearedToDock

- (BOOL) clearedToDock

Definition at line 9242 of file PlayerEntity.m.

{
    return dockingClearanceStatus > DOCKING_CLEARANCE_STATUS_REQUESTED || dockingClearanceStatus == DOCKING_CLEARANCE_STATUS_NOT_REQUIRED;
}

clearExtraGuiScreenKeys:key:

- (void) clearExtraGuiScreenKeys:		(OOGUIScreenID)	gui
key:		(NSString *)	key

Definition at line 9242 of file PlayerEntity.m.

                                :(OOGUIScreenID)gui key:(NSString *)key
{
    NSMutableArray *keydefs = [extraGuiScreenKeys objectForKey:[NSString stringWithFormat:@"%d",gui]];
    NSInteger i = [keydefs count];
    NSDictionary *def = nil;
    while (i--) 
    {
        def = [keydefs objectAtIndex:i];
        if (def && [[def oo_stringForKey:@"name"] isEqualToString:key]) 
        {
            [keydefs removeObjectAtIndex:i];
            break;
        }
    }
    // do we have to put the array back, or does the reference update the source?
}

Referenced by GlobalClearExtraGuiScreenKeys().

Here is the caller graph for this function:

clearExtraMissionKeys

- (void) clearExtraMissionKeys

Definition at line 9242 of file PlayerEntity.m.

{
    [extraMissionKeys release];
    extraMissionKeys = nil;
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

clearMissionDescription

- (void) clearMissionDescription

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    [self clearMissionDescriptionForMission:sCurrentMissionKey];
}

clearMissionDescriptionForMission:

- (void) clearMissionDescriptionForMission:

(NSString *)

key

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                                          :(NSString *)key
{
    if (!key)
    {
        OOLogERR(kOOLogScriptMissionDescNoKey, @"in %@, mission key not set", CurrentScriptDesc());
        return;
    }
    
    if (![mission_variables objectForKey:key]) return;
    
    [mission_variables removeObjectForKey:key];
}

Referenced by MissionSetInstructionsInternal().

Here is the caller graph for this function:

clearMissionScreen

- (void) clearMissionScreen

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    [self setMissionOverlayDescriptor:nil];
    [self setMissionBackgroundDescriptor:nil];
    [self setMissionBackgroundSpecial:nil];
    [self setMissionTitle:nil];
    [self setMissionMusic:nil];
    [self showShipModel:nil];
}

clearMissionScreenID

- (void) clearMissionScreenID

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    [_missionScreenID release];
    _missionScreenID = nil;
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

clearPlanetSearchString

- (void) clearPlanetSearchString

Provided by category PlayerEntity(Controls).

Definition at line 164 of file PlayerEntityControls.m.

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

clearRoleFromPlayer:

- (void) clearRoleFromPlayer:

(BOOL)

includingLongRange

Definition at line 13727 of file PlayerEntity.m.

                            :(BOOL)includingLongRange
{
    NSUInteger slot = Ranrot() % [roleWeights count];
    if (!includingLongRange)
    {
        NSString *role = [roleWeights objectAtIndex:slot];
        // long range roles cleared at 1/2 normal rate
        if ([role hasSuffix:@"+"] && randf() > 0.5)
        {
            return;
        }
    }
    [roleWeights replaceObjectAtIndex:slot withObject:@"player-unknown"];
}

clearRolesFromPlayer:

- (void) clearRolesFromPlayer:

(float)

chance

Definition at line 13727 of file PlayerEntity.m.

                             :(float)chance
{
    NSUInteger i, count=[roleWeights count];
    for (i = 0; i < count; i++)
    {
        if (randf() < chance)
        {
            [roleWeights replaceObjectAtIndex:i withObject:@"player-unknown"];
        }
    }
}

clearTargetMemory

- (void) clearTargetMemory

Definition at line 9242 of file PlayerEntity.m.

{
    NSUInteger memoryCount = [target_memory count];
    for (NSUInteger i = 0; i < PLAYER_TARGET_MEMORY_SIZE; i++)
    {
        if (i < memoryCount)
        {
            [target_memory replaceObjectAtIndex:i withObject:[NSNull null]];
        }
        else
        {
            [target_memory addObject:[NSNull null]];
        }
    }
    target_memory_index = 0;
}

clock_days_number

- (NSNumber *) clock_days_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithUnsignedLongLong:ship_clock / 86400.0];
}

clock_hours_number

- (NSNumber *) clock_hours_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithUnsignedLongLong:ship_clock / 3600.0];
}

clock_mins_number

- (NSNumber *) clock_mins_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithUnsignedLongLong:ship_clock / 60.0];
}

clock_number

- (NSNumber *) clock_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithDouble:ship_clock];
}

clock_secs_number

- (NSNumber *) clock_secs_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithUnsignedLongLong:ship_clock];
}

clockAdjusting

- (BOOL) clockAdjusting

Definition at line 13727 of file PlayerEntity.m.

{
    return ship_clock_adjust > 0;
}

clockTime

- (double) clockTime

Definition at line 13727 of file PlayerEntity.m.

{
    return ship_clock;
}

Referenced by ClockGetProperty().

Here is the caller graph for this function:

clockTimeAdjusted

- (double) clockTimeAdjusted

Definition at line 13727 of file PlayerEntity.m.

{
    return ship_clock + ship_clock_adjust;
}

Referenced by HeadUpDisplay::hudDrawReticleOnTarget.

Here is the caller graph for this function:

collectBountyFor:

- (void) collectBountyFor: (ShipEntity *)  other

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                         :(ShipEntity *)other
{
    if ([self status] == STATUS_DEAD)  return; // no bounty if we died while trying
    
    if (other == nil || [other isSubEntity])  return;
    
    if (other == [UNIVERSE station])
    {
        // there is no way the player can destroy the main station
        // and so the explosion will be cancelled, so there shouldn't
        // be a kill award
        return;
    }
 
    if ([self isCloaked])
    {
        // no-one knows about it; no award
        return;
    }
 
    OOCreditsQuantity   score = 10 * [other bounty];
    OOScanClass         killClass = [other scanClass]; // **tgape** change (+line)
    BOOL                killAward = [other countsAsKill];
    
    if ([other isPolice])   // oops, we shot a copper!
    {
        [self markAsOffender:64 withReason:kOOLegalStatusReasonAttackedPolice];
    }
    
    BOOL killIsCargo = ((killClass == CLASS_CARGO) && ([other commodityAmount] > 0) && ![other isHulk]);
    if ((killIsCargo) || (killClass == CLASS_BUOY) || (killClass == CLASS_ROCK))
    {
        // EMMSTRAN: no killaward (but full bounty) for tharglets?
        if (![other hasRole:@"tharglet"])   // okay, we'll count tharglets as proper kills
        {
            score /= 10;    // reduce bounty awarded
            killAward = NO; // don't award a kill
        }
    }
    
    credits += score;
    
    if (score > 9)
    {
        NSString *bonusMessage = OOExpandKey(@"bounty-awarded", score, credits);
        [UNIVERSE addDelayedMessage:bonusMessage forCount:6 afterDelay:0.15];
    }
    
    if (killAward)
    {
        ship_kills++;
        if ((ship_kills % 256) == 0)
        {
            // congratulations method needs to be delayed a fraction of a second
            [UNIVERSE addDelayedMessage:DESC(@"right-on-commander") forCount:4 afterDelay:0.2];
        }
    }
}

commanderBountyAsString

- (NSString *) commanderBountyAsString

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return [NSString stringWithFormat:@"%i", [self legalStatus]];
}

commanderDataDictionary

- (NSDictionary *) commanderDataDictionary

Definition at line 13727 of file PlayerEntity.m.

{
    int i;
 
    NSMutableDictionary *result = [NSMutableDictionary dictionary];
    
    [result setObject:[[[NSBundle mainBundle] infoDictionary] objectForKey:@"CFBundleVersion"] forKey:@"written_by_version"];
 
    NSString    *gal_id = [NSString stringWithFormat:@"%u", galaxy_number];
    NSString    *sys_id = [NSString stringWithFormat:@"%d", system_id];
    NSString    *tgt_id = [NSString stringWithFormat:@"%d", target_system_id];
    NSString    *prv_id = [NSString stringWithFormat:@"%d", previous_system_id];
 
    // Variable requiredCargoSpace not suitable for Oolite as it currently stands: it retroactively changes a savegame cargo space.
    //unsigned  passenger_space = [[OOEquipmentType equipmentTypeWithIdentifier:@"EQ_PASSENGER_BERTH"] requiredCargoSpace];
    //if (passenger_space == 0) passenger_space = PASSENGER_BERTH_SPACE;
    
    [result setObject:gal_id        forKey:@"galaxy_id"];
    [result setObject:sys_id    forKey:@"system_id"];
    [result setObject:tgt_id    forKey:@"target_id"];
    [result setObject:prv_id    forKey:@"previous_system_id"];
    [result setObject:[NSNumber numberWithFloat:saved_chart_zoom] forKey:@"chart_zoom"];
    [result setObject:[NSNumber numberWithInt:ANA_mode] forKey:@"chart_ana_mode"];
    [result setObject:[NSNumber numberWithInt:longRangeChartMode] forKey:@"chart_colour_mode"];
 
 
    if (found_system_id >= 0)
    {
        NSString *found_id = [NSString stringWithFormat:@"%d", found_system_id];
        [result setObject:found_id  forKey:@"found_system_id"];
    }
    
    // Write the name of the current system. Useful for looking up saved game information and for overlapping systems.
    if (![UNIVERSE inInterstellarSpace])
    {
        [result setObject:[UNIVERSE getSystemName:[self currentSystemID]] forKey:@"current_system_name"];
        OOGovernmentID government = [[UNIVERSE currentSystemData] oo_intForKey:KEY_GOVERNMENT];
        OOTechLevelID techlevel = [[UNIVERSE currentSystemData] oo_intForKey:KEY_TECHLEVEL];
        OOEconomyID economy = [[UNIVERSE currentSystemData] oo_intForKey:KEY_ECONOMY];
        [result setObject:[NSNumber numberWithUnsignedShort:government] forKey:@"current_system_government"];
        [result setObject:[NSNumber numberWithUnsignedInteger:techlevel] forKey:@"current_system_techlevel"];
        [result setObject:[NSNumber numberWithUnsignedShort:economy] forKey:@"current_system_economy"];
    }
    
    [result setObject:[self commanderName] forKey:@"player_name"];
    [result setObject:[self lastsaveName] forKey:@"player_save_name"];
    [result setObject:[self shipUniqueName] forKey:@"ship_unique_name"];
    [result setObject:[self shipClassName] forKey:@"ship_class_name"];
 
    /*
        BUG: GNUstep truncates integer values to 32 bits when loading XML plists.
        Workaround: store credits as a double. 53 bits of precision ought to
        be good enough for anybody. Besides, we display credits with double
        precision anyway.
        -- Ahruman 2011-02-15
    */
    [result oo_setFloat:credits             forKey:@"credits"];
    [result oo_setUnsignedInteger:fuel      forKey:@"fuel"];
    
    [result oo_setInteger:galaxy_number forKey:@"galaxy_number"];
    
    [result oo_setBool:[self weaponsOnline] forKey:@"weapons_online"];
    
    if (forward_weapon_type != nil)
    {
        [result setObject:[forward_weapon_type identifier]  forKey:@"forward_weapon"];
    }
    if (aft_weapon_type != nil)
    {
        [result setObject:[aft_weapon_type identifier]      forKey:@"aft_weapon"];
    }
    if (port_weapon_type != nil)
    {
        [result setObject:[port_weapon_type identifier]     forKey:@"port_weapon"];
    }
    if (starboard_weapon_type != nil)
    {
        [result setObject:[starboard_weapon_type identifier]    forKey:@"starboard_weapon"];
    }
    [result setObject:[self serializeShipSubEntities] forKey:@"subentities_status"];
    if (hud != nil && [hud nonlinearScanner])
    {
        [result oo_setFloat: [hud scannerZoom] forKey:@"ship_scanner_zoom"];
    }
    
    [result oo_setInteger:max_cargo + PASSENGER_BERTH_SPACE * max_passengers    forKey:@"max_cargo"];
    
    [result setObject:[shipCommodityData savePlayerAmounts]     forKey:@"shipCommodityData"];
    
    
    NSMutableArray *missileRoles = [NSMutableArray arrayWithCapacity:max_missiles];
    
    for (i = 0; i < (int)max_missiles; i++)
    {
        if (missile_entity[i])
        {
            [missileRoles addObject:[missile_entity[i] primaryRole]];
        }
        else
        {
            [missileRoles addObject:@"NONE"];
        }
    }
    [result setObject:missileRoles forKey:@"missile_roles"];
    
    [result oo_setInteger:missiles forKey:@"missiles"];
    
    [result oo_setInteger:legalStatus forKey:@"legal_status"];
    [result oo_setInteger:market_rnd forKey:@"market_rnd"];
    [result oo_setInteger:ship_kills forKey:@"ship_kills"];
 
    // ship depreciation
    [result oo_setInteger:ship_trade_in_factor forKey:@"ship_trade_in_factor"];
 
    // mission variables
    if (mission_variables != nil)
    {
        [result setObject:[NSDictionary dictionaryWithDictionary:mission_variables] forKey:@"mission_variables"];
    }
 
    // communications log
    NSArray *log = [self commLog];
    if (log != nil)  [result setObject:log forKey:@"comm_log"];
    
    [result oo_setUnsignedInteger:entity_personality forKey:@"entity_personality"];
    
    // extra equipment flags
    NSMutableDictionary *equipment = [NSMutableDictionary dictionary];
    NSEnumerator        *eqEnum = nil;
    NSString            *eqDesc = nil;
    for (eqEnum = [self equipmentEnumerator]; (eqDesc = [eqEnum nextObject]); )
    {
        [equipment oo_setInteger:[self countEquipmentItem:eqDesc] forKey:eqDesc];
    }
    if ([equipment count] != 0)
    {
        [result setObject:equipment forKey:@"extra_equipment"];
    }
    if (primedEquipment < [eqScripts count]) [result setObject:[[eqScripts oo_arrayAtIndex:primedEquipment] oo_stringAtIndex:0] forKey:@"primed_equipment"];
    
    [result setObject:[self fastEquipmentA] forKey:@"primed_equipment_a"];
    [result setObject:[self fastEquipmentB] forKey:@"primed_equipment_b"];
 
    // roles
    [result setObject:roleWeights forKey:@"role_weights"];
 
    // role information
    [result setObject:roleWeightFlags forKey:@"role_weight_flags"];
 
    // role information
    [result setObject:roleSystemList forKey:@"role_system_memory"];
 
    // reputation
    [result setObject:reputation forKey:@"reputation"];
    
    // initialise parcel reputations in dictionary if not set
    int pGood = [reputation oo_intForKey:PARCEL_GOOD_KEY];
    int pBad = [reputation oo_intForKey:PARCEL_BAD_KEY];
    int pUnknown = [reputation oo_intForKey:PARCEL_UNKNOWN_KEY];
    if (pGood+pBad+pUnknown != MAX_CONTRACT_REP)
    {
        [reputation oo_setInteger:0 forKey:PARCEL_GOOD_KEY];
        [reputation oo_setInteger:0 forKey:PARCEL_BAD_KEY];
        [reputation oo_setInteger:MAX_CONTRACT_REP forKey:PARCEL_UNKNOWN_KEY];
    }
 
    // passengers
    [result oo_setInteger:max_passengers forKey:@"max_passengers"];
    [result setObject:passengers forKey:@"passengers"];
    [result setObject:passenger_record forKey:@"passenger_record"];
 
    // parcels
    [result setObject:parcels forKey:@"parcels"];
    [result setObject:parcel_record forKey:@"parcel_record"];
    
    //specialCargo
    if (specialCargo)  [result setObject:specialCargo forKey:@"special_cargo"];
    
    // contracts
    [result setObject:contracts forKey:@"contracts"];
    [result setObject:contract_record forKey:@"contract_record"];
 
    [result setObject:missionDestinations forKey:@"mission_destinations"];
 
    //shipyard
    [result setObject:shipyard_record forKey:@"shipyard_record"];
 
    //ship's clock
    [result setObject:[NSNumber numberWithDouble:ship_clock] forKey:@"ship_clock"];
 
    //speech
    [result setObject:[NSNumber numberWithInt:isSpeechOn] forKey:@"speech_on"];
#if OOLITE_ESPEAK
    [result setObject:[UNIVERSE voiceName:voice_no] forKey:@"speech_voice"];
    [result setObject:[NSNumber numberWithBool:voice_gender_m] forKey:@"speech_gender"];
#endif
    
    // docking clearance
    [result setObject:[NSNumber numberWithBool:[UNIVERSE dockingClearanceProtocolActive]] forKey:@"docking_clearance_protocol"];
 
    //base ship description
    [result setObject:[self shipDataKey] forKey:@"ship_desc"];
    [result setObject:[[self shipInfoDictionary] oo_stringForKey:KEY_NAME] forKey:@"ship_name"];
 
    //custom view no.
    [result oo_setUnsignedInteger:_customViewIndex forKey:@"custom_view_index"];
 
    // escape pod rescue time
    [result oo_setFloat:[self escapePodRescueTime] forKey:@"escape_pod_rescue_time"];
 
    //local market for main station
    if ([[UNIVERSE station] localMarket])  [result setObject:[[[UNIVERSE station] localMarket] saveStationAmounts] forKey:@"localMarket"];
 
    // Scenario restriction on OXZs
    [result setObject:[UNIVERSE useAddOns] forKey:@"scenario_restriction"];
 
    [result setObject:[[UNIVERSE systemManager] exportScriptedChanges] forKey:@"scripted_planetinfo_overrides"];
 
    // trumble information
    [result setObject:[self trumbleValue] forKey:@"trumbles"];
 
    // wormhole information
    NSMutableArray *wormholeDicts = [NSMutableArray arrayWithCapacity:[scannedWormholes count]];
    WormholeEntity *wh = nil;
    foreach (wh, scannedWormholes)
    {
        [wormholeDicts addObject:[wh getDict]];
    }
    [result setObject:wormholeDicts forKey:@"wormholes"];
 
    // docked station
    StationEntity *dockedStation = [self dockedStation];
    [result setObject:dockedStation != nil ? [dockedStation primaryRole]:(NSString *)@"" forKey:@"docked_station_role"];
    if (dockedStation)
    {
        HPVector dpos = [dockedStation position];
        [result setObject:ArrayFromHPVector(dpos) forKey:@"docked_station_position"];
    }
    else
    {
        [result setObject:[NSArray array] forKey:@"docked_station_position"];
    }
    [result setObject:[UNIVERSE getStationMarkets] forKey:@"station_markets"];
 
    // scenario information
    if (scenarioKey != nil)
    {
        [result setObject:scenarioKey forKey:@"scenario"];
    }
 
    // create checksum
    clear_checksum();
// TODO: should checksum checks be removed?
//  munge_checksum(galaxy_seed.a);  munge_checksum(galaxy_seed.b);  munge_checksum(galaxy_seed.c);
//  munge_checksum(galaxy_seed.d);  munge_checksum(galaxy_seed.e);  munge_checksum(galaxy_seed.f);
    munge_checksum(galaxy_coordinates.x);   munge_checksum(galaxy_coordinates.y);
    munge_checksum(credits);        munge_checksum(fuel);
    munge_checksum(max_cargo);      munge_checksum(missiles);
    munge_checksum(legalStatus);    munge_checksum(market_rnd);     munge_checksum(ship_kills);
    
    if (mission_variables != nil)
    {
        munge_checksum([[mission_variables description] length]);
    }
    if (equipment != nil)
    {
        munge_checksum([[equipment description] length]);
    }
    
    int final_checksum = munge_checksum([[self shipDataKey] length]);
 
    //set checksum
    [result oo_setInteger:final_checksum forKey:@"checksum"];
    
    return result;
}

Referenced by PlayerShipGetProperty().

Here is the caller graph for this function:

commanderKillsAsString

- (NSString *) commanderKillsAsString

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return [NSString stringWithFormat:@"%i", [self score]];
}

commanderLegalStatus_number

- (NSNumber *) commanderLegalStatus_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:[self legalStatus]];
}

commanderLegalStatus_string

- (NSString *) commanderLegalStatus_string

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return OODisplayStringFromLegalStatus(legalStatus);
}

commanderName

- (NSString *) commanderName

Definition at line 9242 of file PlayerEntity.m.

{
    return _commanderName;
}

Referenced by PlayerGetProperty().

Here is the caller graph for this function:

commanderName_string

- (NSString *) commanderName_string

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [self commanderName];
}

commanderRank_string

- (NSString *) commanderRank_string

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return OODisplayRatingStringFromKillCount([self score]);
}

commanderSelector

- (NSString *) commanderSelector

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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;
}

commanderShip_string

- (NSString *) commanderShip_string

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [self name];
}

commanderShipDisplayName_string

- (NSString *) commanderShipDisplayName_string

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [self displayName];
}

commLog

- (NSMutableArray *) commLog

commodityScriptNamed:

- (OOScript *) commodityScriptNamed:

(NSString *)

script

Definition at line 9242 of file PlayerEntity.m.

                                   :(NSString *)scriptName
{
    if (scriptName == nil)
    {
        return nil;
    }
    OOScript *cscript = nil;
    if ((cscript = [commodityScripts objectForKey:scriptName]))
    {
        return cscript;
    }
    cscript = [OOScript jsScriptFromFileNamed:scriptName properties:nil];
    if (cscript != nil)
    {
        // storing it in here retains it
        [commodityScripts setObject:cscript forKey:scriptName];
    }
    else
    {
        OOLog(@"script.commodityScript.load",@"Could not load script %@",scriptName);
    }
    return cscript;
}

commsMessage:

- (void) commsMessage:

(NSString *)

valueString

Reimplemented from ShipEntity.

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                     :(NSString *)valueString
{   
    [UNIVERSE addCommsMessage:[self expandMessage:valueString] forCount:4.5];
}

commsMessageByUnpiloted:

- (void) commsMessageByUnpiloted:

(NSString *)

valueString

Reimplemented from ShipEntity.

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                                :(NSString *)valueString
{
    [self commsMessage:valueString];
}

compareKeyEntries:second:

- (BOOL) compareKeyEntries: (NSDictionary*)  first second: (NSDictionary*)  second

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                          :(NSDictionary*)first second:(NSDictionary*)second
{
    if ([(NSString *)[first objectForKey:@"key"] integerValue] == [(NSString *)[second objectForKey:@"key"] integerValue])
    {
        if ([[first objectForKey:@"shift"] boolValue] == [[second objectForKey:@"shift"] boolValue] &&
            [[first objectForKey:@"mod1"] boolValue] == [[second objectForKey:@"mod1"] boolValue] &&
            [[first objectForKey:@"mod2"] boolValue] == [[second objectForKey:@"mod2"] boolValue]) 
            return YES;
    }
    return NO;
}

compareZeroDistance:

- (NSComparisonResult) compareZeroDistance: (Entity *)  otherEntity

implementation

Reimplemented from Entity.

Definition at line 13727 of file PlayerEntity.m.

                                          :(Entity *)otherEntity
{
    return NSOrderedDescending;  // always the most near
}

compassMode

- (OOCompassMode) compassMode

compassTarget

- (Entity *) compassTarget

compassTargetLabel

- (NSString *) compassTargetLabel

Definition at line 13727 of file PlayerEntity.m.

{
    switch (compassMode)
    {
    case COMPASS_MODE_INACTIVE:
        return @"";
    case COMPASS_MODE_BASIC:
        return @"";
    case COMPASS_MODE_BEACONS:
    {
        Entity *target = [self compassTarget];
        if (target)
        {
            return [(Entity <OOBeaconEntity> *)target beaconLabel];
        }
        return @"";
    }
    case COMPASS_MODE_PLANET:
        return [[UNIVERSE planet] name];
    case COMPASS_MODE_SUN:
        return [[UNIVERSE sun] name];
    case COMPASS_MODE_STATION:
        return [[UNIVERSE station] displayName];
    case COMPASS_MODE_TARGET:
        return DESC(@"oolite-beacon-label-target");
    }
    return @"";
}

completeSetUp

- (void) completeSetUp

Definition at line 13727 of file PlayerEntity.m.

{
    [self completeSetUpAndSetTarget:YES];
}

completeSetUpAndSetTarget:

- (void) completeSetUpAndSetTarget:

(BOOL)

setTarget

Definition at line 13727 of file PlayerEntity.m.

                                  :(BOOL)setTarget
{
    [OOSoundSource stopAll];
 
    [self setDockedStation:[UNIVERSE station]];
    [self setLastAegisLock:[UNIVERSE planet]];
    // only do this if we're not in strict mode, otherwise all previously saved OXP key/joystick defs will be wiped.
    if (![[UNIVERSE useAddOns] isEqualToString:SCENARIO_OXP_DEFINITION_NONE]) 
    {
        [self validateCustomEquipActivationArray];
    }
 
    JSContext *context = OOJSAcquireContext();
    [self doWorldScriptEvent:OOJSID("startUp") inContext:context withArguments:NULL count:0 timeLimit:MAX(0.0, [[NSUserDefaults standardUserDefaults] oo_floatForKey:@"start-script-limit-value" defaultValue:kOOJSLongTimeLimit])];
    OOJSRelinquishContext(context);
}

consoleMessage3s:

- (void) consoleMessage3s:

(NSString *)

valueString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                         :(NSString *)valueString
{
    [UNIVERSE addMessage:[self expandMessage:valueString] forCount: 3];
}

consoleMessage6s:

- (void) consoleMessage6s:

(NSString *)

valueString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                         :(NSString *)valueString
{
    [UNIVERSE addMessage:[self expandMessage:valueString] forCount: 6];
}

contractedVolumeForGood:

- (OOCargoQuantity) contractedVolumeForGood:

(OOCommodityType)

good

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                                           :(OOCommodityType) good
{
    OOCargoQuantity total = 0;
    for (unsigned i = 0; i < [contracts count]; i++)
    {
        NSDictionary* contract_info = [contracts oo_dictionaryAtIndex:i];
        OOCommodityType contract_cargo_type = [contract_info oo_stringForKey:CARGO_KEY_TYPE];
        if ([good isEqualToString:contract_cargo_type])
        {
            total += [contract_info oo_unsignedIntegerForKey:CARGO_KEY_AMOUNT];
        }
    }
    return total;
}

contractList

- (NSArray *) contractList

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    return [self contractsListFromArray:contracts forCargo:YES forParcels:NO];
}

contractListForScripting

- (NSArray *) contractListForScripting

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    return [self contractsListForScriptingFromArray:contracts forCargo:YES];
}

contractReputation

- (int) contractReputation

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    int good = [reputation oo_intForKey:CONTRACTS_GOOD_KEY];
    int bad = [reputation oo_intForKey:CONTRACTS_BAD_KEY];
    int unknown = [reputation oo_intForKey:CONTRACTS_UNKNOWN_KEY];
    
    if (unknown > 0)
        unknown = MAX_CONTRACT_REP - (((2*unknown)+(market_rnd % unknown))/3);
    else
        unknown = MAX_CONTRACT_REP;
    
    return (good + unknown - 3 * bad) / 2;  // return a number from -MAX_CONTRACT_REP to +MAX_CONTRACT_REP
}

contractsListForScriptingFromArray:forCargo:

- (NSArray *) contractsListForScriptingFromArray: (NSArray *)  contracts_array forCargo: (BOOL)  forCargo

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                                               :(NSArray *) contracts_array forCargo:(BOOL)forCargo
{
    NSMutableArray      *result = [NSMutableArray array];
    NSUInteger          i;
 
    for (i = 0; i < [contracts_array count]; i++)
    {
        NSMutableDictionary *contract = [NSMutableDictionary dictionaryWithCapacity:10];
        NSDictionary        *dict = [contracts_array oo_dictionaryAtIndex:i];
        if (forCargo)
        {
            // commodity, quantity - keep consistency between .manifest and .contracts
            [contract setObject:[dict oo_stringForKey:CARGO_KEY_TYPE] forKey:@"commodity"];
            [contract setObject:[NSNumber numberWithUnsignedInt:[dict oo_intForKey:CARGO_KEY_AMOUNT]] forKey:@"quantity"];
            [contract setObject:[dict oo_stringForKey:CARGO_KEY_DESCRIPTION] forKey:@"description"];
        }
        else
        {
            [contract setObject:[dict oo_stringForKey:PASSENGER_KEY_NAME] forKey:PASSENGER_KEY_NAME];
            [contract setObject:[NSNumber numberWithUnsignedInt:[dict oo_unsignedIntForKey:CONTRACT_KEY_RISK]] forKey:CONTRACT_KEY_RISK]; 
        }
        
        OOSystemID  planet = [dict oo_intForKey:CONTRACT_KEY_DESTINATION];
        NSString    *planetName = [UNIVERSE getSystemName:planet];
        [contract setObject:[NSNumber numberWithUnsignedInt:planet] forKey:CONTRACT_KEY_DESTINATION];
        [contract setObject:planetName forKey:@"destinationName"];
        planet = [dict oo_intForKey:CONTRACT_KEY_START];
        planetName = [UNIVERSE getSystemName: planet];
        [contract setObject:[NSNumber numberWithUnsignedInt:planet] forKey:CONTRACT_KEY_START];
        [contract setObject:planetName forKey:@"startName"];
        
        int         dest_eta = [dict oo_doubleForKey:CONTRACT_KEY_ARRIVAL_TIME] - ship_clock;
        [contract setObject:[NSNumber numberWithInt:dest_eta] forKey:@"eta"];
        [contract setObject:[UNIVERSE shortTimeDescription:dest_eta] forKey:@"etaDescription"];
        [contract setObject:[NSNumber numberWithInt:[dict oo_intForKey:CONTRACT_KEY_PREMIUM]] forKey:CONTRACT_KEY_PREMIUM]; 
        [contract setObject:[NSNumber numberWithInt:[dict oo_intForKey:CONTRACT_KEY_FEE]] forKey:CONTRACT_KEY_FEE]; 
        [result addObject:contract];
    }
 
    return [[result copy] autorelease]; // return an immutable copy
}

contractsListFromArray:forCargo:forParcels:

- (NSArray *) contractsListFromArray: (NSArray *)  contracts_array forCargo: (BOOL)  forCargo forParcels: (BOOL)  forParcels

implementation

Provided by category PlayerEntity(ContractsPrivate).

Definition at line 1998 of file PlayerEntityContracts.m.

                                   :(NSArray *) contracts_array forCargo:(BOOL) forCargo forParcels:(BOOL)forParcels
{
    // check  contracts
    NSMutableArray  *result = [NSMutableArray arrayWithCapacity:5];
    NSString        *formatString = (forCargo||forParcels) ? @"oolite-manifest-item-delivery" : @"oolite-manifest-person-travelling";
    unsigned i;
    for (i = 0; i < [contracts_array count]; i++)
    {
        NSDictionary* contract_info = (NSDictionary *)[contracts_array objectAtIndex:i];
        NSString* label = [contract_info oo_stringForKey:forCargo ? CARGO_KEY_DESCRIPTION : PASSENGER_KEY_NAME];
        // the system name can change via script. The following PASSENGER_KEYs are identical to the corresponding CONTRACT_KEYs
        NSString* destination = [UNIVERSE getSystemName: [contract_info oo_intForKey:CONTRACT_KEY_DESTINATION]];
        int dest_eta = [contract_info oo_doubleForKey:CONTRACT_KEY_ARRIVAL_TIME] - ship_clock;
        NSString *deadline = [UNIVERSE shortTimeDescription:dest_eta];
 
        OOCreditsQuantity fee = [contract_info oo_intForKey:CONTRACT_KEY_FEE];
        NSString *feeDesc = OOIntCredits(fee);
 
        [result addObject:OOExpandKey(formatString, label, destination, deadline, feeDesc)];
 
    }
    
    return result;
}

countMissiles

- (unsigned) countMissiles

Definition at line 13727 of file PlayerEntity.m.

{
    unsigned n_missiles = 0;
    unsigned i;
    for (i = 0; i < max_missiles; i++)
    {
        if (missile_entity[i])
            n_missiles++;
    }
    return n_missiles;
}

createCargoPodWithType:andAmount:

- (void) createCargoPodWithType: (OOCommodityType)  type andAmount: (OOCargoQuantity)  amount

implementation

Definition at line 13727 of file PlayerEntity.m.

                               :(OOCommodityType)type andAmount:(OOCargoQuantity)amount
{
    ShipEntity *container = [UNIVERSE newShipWithRole:@"1t-cargopod"];
    if (container)
    {
        [container setScanClass: CLASS_CARGO];
        [container setStatus:STATUS_IN_HOLD];
        [container setCommodity:type andAmount:amount];
        [cargo addObject:container];
        [container release];
    }
    else
    {
        OOLogERR(@"player.loadCargoPods.noContainer", @"%@", @"couldn't create a container in [PlayerEntity loadCargoPods]");
        // throw an exception here...
        [NSException raise:OOLITE_EXCEPTION_FATAL
                                format:@"[PlayerEntity loadCargoPods] failed to create a container for cargo with role 'cargopod'"];
    }
}

createDoppelganger

- (ProxyPlayerEntity *) createDoppelganger

implementation

Definition at line 13727 of file PlayerEntity.m.

{
    ProxyPlayerEntity *result = (ProxyPlayerEntity *)[[UNIVERSE newShipWithName:[self shipDataKey] usePlayerProxy:YES] autorelease];
    
    if (result != nil)
    {
        [result setPosition:[self position]];
        [result setScanClass:CLASS_NEUTRAL];
        [result setOrientation:[self normalOrientation]];
        [result setVelocity:[self velocity]];
        [result setSpeed:[self flightSpeed]];
        [result setDesiredSpeed:[self flightSpeed]];
        [result setRoll:flightRoll];
        [result setBehaviour:BEHAVIOUR_IDLE];
        [result switchAITo:@"nullAI.plist"];  // fly straight on
        [result setTemperature:[self temperature]];
        [result copyValuesFromPlayer:self];
    }
    
    return result;
}

creditBalance

- (double) creditBalance

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return 0.1 * credits;
}

credits_number

- (NSNumber *) credits_number

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithDouble:[self creditBalance]];
}

creditsFormattedForLegacySubstitution

- (NSString *) creditsFormattedForLegacySubstitution

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    OOCreditsQuantity   tenthsOfCredits = [self deciCredits];
    unsigned long long  integerCredits = tenthsOfCredits / 10;
    unsigned long long  tenths = tenthsOfCredits % 10;
    
    return [NSString stringWithFormat:@"%llu.%llu", integerCredits, tenths];
}

creditsFormattedForSubstitution

- (NSString *) creditsFormattedForSubstitution

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return OOStringFromDeciCredits([self deciCredits], YES, NO);
}

currentGalaxyID

- (OOGalaxyID) currentGalaxyID

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return galaxy_number;
}

Referenced by SystemSetProperty(), and SystemToString().

Here is the caller graph for this function:

currentLaserOffset

- (NSArray *) currentLaserOffset

Definition at line 13727 of file PlayerEntity.m.

{
    return [self laserPortOffset:currentWeaponFacing];
}

currentPrimedEquipment

- (NSString *) currentPrimedEquipment

Definition at line 13727 of file PlayerEntity.m.

{
    NSString *result = @"";
    NSUInteger c = [eqScripts count];
    if (primedEquipment != c)
    {
        result = [[eqScripts oo_arrayAtIndex:primedEquipment] oo_stringAtIndex:0];
    }
    return result;
}

Referenced by PlayerShipGetProperty().

Here is the caller graph for this function:

CurrentScriptDesc(void)

- (OOINLINE NSString * CurrentScriptDesc(void)) (void)

implementation

Provided by category PlayerEntity(Scripting).

Definition at line 129 of file PlayerEntityLegacyScriptEngine.m.

{
    return CurrentScriptNameOr(@"<anonymous actions>");
}

CurrentScriptNameOr

+ (static NSString *) CurrentScriptNameOr (NSString *)  alternative

implementation

Provided by category PlayerEntity(Scripting).

Definition at line 119 of file PlayerEntityLegacyScriptEngine.m.

{
    if (sCurrentMissionKey != nil && ![sCurrentMissionKey hasPrefix:kActionTempPrefix])
    {
        return [NSString stringWithFormat:@"\"%@\"", sCurrentMissionKey];
    }
    return alternative;
}

currentSystemID

- (OOSystemID) currentSystemID

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    if ([UNIVERSE sun] == nil)  return -1;  // Interstellar space
    return [UNIVERSE currentSystemID];
}

Referenced by SystemSetProperty(), and SystemToString().

Here is the caller graph for this function:

currentWeapon

- (OOWeaponType) currentWeapon

Definition at line 13727 of file PlayerEntity.m.

{
    return [self weaponForFacing:currentWeaponFacing];
}

currentWeaponStats

- (void) currentWeaponStats

Definition at line 13727 of file PlayerEntity.m.

{
    OOWeaponType currentWeapon = [self currentWeapon];
    // Did find & correct a minor mismatch between player and NPC weapon stats. This is the resulting code - Kaks 20101027
    
    // Basic stats: weapon_damage & weaponRange (weapon_recharge_rate is not used by the player)
    [self setWeaponDataFromType:currentWeapon];
}

cursor_coordinates

- (NSPoint) cursor_coordinates

custom_chart_centre_coordinates

- (NSPoint) custom_chart_centre_coordinates

custom_chart_zoom

- (OOScalar) custom_chart_zoom

customEquipmentActivation

- (NSMutableArray *) customEquipmentActivation

Definition at line 9242 of file PlayerEntity.m.

{
    return customEquipActivation;
}

customViewDescription

- (NSString *) customViewDescription

customViewForwardVector

- (Vector) customViewForwardVector

customViewMatrix

- (OOMatrix) customViewMatrix

customViewOffset

- (Vector) customViewOffset

customViewPanDown:

- (void) customViewPanDown:

(OOScalar)

angle

Definition at line 9242 of file PlayerEntity.m.

                          :(OOScalar) angle
{
    quaternion_rotate_about_axis(&customViewQuaternion, customViewRightVector, -angle);
    [self setCustomViewData];
    customViewRotationCenter = vector_subtract(customViewOffset, vector_multiply_scalar(customViewForwardVector, dot_product(customViewOffset, customViewForwardVector)));
}

customViewPanLeft:

- (void) customViewPanLeft:

(OOScalar)

angle

Definition at line 9242 of file PlayerEntity.m.

                          :(OOScalar) angle
{
    quaternion_rotate_about_axis(&customViewQuaternion, customViewUpVector, angle);
    [self setCustomViewData];
    customViewRotationCenter = vector_subtract(customViewOffset, vector_multiply_scalar(customViewForwardVector, dot_product(customViewOffset, customViewForwardVector)));
}

customViewPanRight:

- (void) customViewPanRight:

(OOScalar)

angle

Definition at line 9242 of file PlayerEntity.m.

                           :(OOScalar) angle
{
    quaternion_rotate_about_axis(&customViewQuaternion, customViewUpVector, -angle);
    [self setCustomViewData];
    customViewRotationCenter = vector_subtract(customViewOffset, vector_multiply_scalar(customViewForwardVector, dot_product(customViewOffset, customViewForwardVector)));
}

customViewPanUp:

- (void) customViewPanUp:

(OOScalar)

angle

Definition at line 9242 of file PlayerEntity.m.

                        :(OOScalar) angle
{
    quaternion_rotate_about_axis(&customViewQuaternion, customViewRightVector, angle);
    [self setCustomViewData];
    customViewRotationCenter = vector_subtract(customViewOffset, vector_multiply_scalar(customViewForwardVector, dot_product(customViewOffset, customViewForwardVector)));
}

customViewQuaternion

- (Quaternion) customViewQuaternion

customViewRightVector

- (Vector) customViewRightVector

customViewRollLeft:

- (void) customViewRollLeft:

(OOScalar)

angle

Definition at line 9242 of file PlayerEntity.m.

                           :(OOScalar) angle
{
    customViewOffset = vector_subtract(customViewOffset, customViewRotationCenter);
    OOScalar m = magnitude(customViewOffset);
    quaternion_rotate_about_axis(&customViewQuaternion, customViewForwardVector, angle);
    [self setCustomViewData];
    customViewOffset = vector_flip(customViewForwardVector);
    scale_vector(&customViewOffset, m / magnitude(customViewOffset));
    customViewOffset = vector_add(customViewOffset, customViewRotationCenter);
}

customViewRollRight:

- (void) customViewRollRight:

(OOScalar)

angle

Definition at line 9242 of file PlayerEntity.m.

                            :(OOScalar) angle
{
    customViewOffset = vector_subtract(customViewOffset, customViewRotationCenter);
    OOScalar m = magnitude(customViewOffset);
    quaternion_rotate_about_axis(&customViewQuaternion, customViewForwardVector, -angle);
    [self setCustomViewData];
    customViewOffset = vector_flip(customViewForwardVector);
    scale_vector(&customViewOffset, m / magnitude(customViewOffset));
    customViewOffset = vector_add(customViewOffset, customViewRotationCenter);
}

customViewRotateDown:

- (void) customViewRotateDown:

(OOScalar)

angle

Definition at line 9242 of file PlayerEntity.m.

                             :(OOScalar) angle
{
    customViewOffset = vector_subtract(customViewOffset, customViewRotationCenter);
    OOScalar m = magnitude(customViewOffset);
    quaternion_rotate_about_axis(&customViewQuaternion, customViewRightVector, angle);
    [self setCustomViewData];
    customViewOffset = vector_flip(customViewForwardVector);
    scale_vector(&customViewOffset, m / magnitude(customViewOffset));
    customViewOffset = vector_add(customViewOffset, customViewRotationCenter);
}

customViewRotateLeft:

- (void) customViewRotateLeft:

(OOScalar)

angle

Definition at line 9242 of file PlayerEntity.m.

                             :(OOScalar) angle
{
    customViewOffset = vector_subtract(customViewOffset, customViewRotationCenter);
    OOScalar m = magnitude(customViewOffset);
    quaternion_rotate_about_axis(&customViewQuaternion, customViewUpVector, -angle);
    [self setCustomViewData];
    customViewOffset = vector_flip(customViewForwardVector);
    scale_vector(&customViewOffset, m / magnitude(customViewOffset));
    customViewOffset = vector_add(customViewOffset, customViewRotationCenter);
}

customViewRotateRight:

- (void) customViewRotateRight:

(OOScalar)

angle

Definition at line 9242 of file PlayerEntity.m.

                              :(OOScalar) angle
{
    customViewOffset = vector_subtract(customViewOffset, customViewRotationCenter);
    OOScalar m = magnitude(customViewOffset);
    quaternion_rotate_about_axis(&customViewQuaternion, customViewUpVector, angle);
    [self setCustomViewData];
    customViewOffset = vector_flip(customViewForwardVector);
    scale_vector(&customViewOffset, m / magnitude(customViewOffset));
    customViewOffset = vector_add(customViewOffset, customViewRotationCenter);
}

customViewRotateUp:

- (void) customViewRotateUp:

(OOScalar)

angle

Definition at line 9242 of file PlayerEntity.m.

                           :(OOScalar) angle
{
    customViewOffset = vector_subtract(customViewOffset, customViewRotationCenter);
    OOScalar m = magnitude(customViewOffset);
    quaternion_rotate_about_axis(&customViewQuaternion, customViewRightVector, -angle);
    [self setCustomViewData];
    customViewOffset = vector_flip(customViewForwardVector);
    scale_vector(&customViewOffset, m / magnitude(customViewOffset));
    customViewOffset = vector_add(customViewOffset, customViewRotationCenter);
}

customViewRotationCenter

- (Vector) customViewRotationCenter

customViewUpVector

- (Vector) customViewUpVector

customViewZoomIn:

- (void) customViewZoomIn:

(OOScalar)

rate

Definition at line 9242 of file PlayerEntity.m.

                         :(OOScalar) rate
{
    customViewOffset = vector_subtract(customViewOffset, customViewRotationCenter);
    customViewOffset = vector_multiply_scalar(customViewOffset, 1.0/rate);
    OOScalar m = magnitude(customViewOffset);
    if (m < CUSTOM_VIEW_MAX_ZOOM_IN * collision_radius)
    {
        scale_vector(&customViewOffset, CUSTOM_VIEW_MAX_ZOOM_IN * collision_radius / m);
    }
    customViewOffset = vector_add(customViewOffset, customViewRotationCenter);
}

customViewZoomOut:

- (void) customViewZoomOut:

(OOScalar)

rate

Definition at line 9242 of file PlayerEntity.m.

                          :(OOScalar) rate
{
    customViewOffset = vector_subtract(customViewOffset, customViewRotationCenter);
    customViewOffset = vector_multiply_scalar(customViewOffset, rate);
    OOScalar m = magnitude(customViewOffset);
    if (m > CUSTOM_VIEW_MAX_ZOOM_OUT * collision_radius)
    {
        scale_vector(&customViewOffset, CUSTOM_VIEW_MAX_ZOOM_OUT * collision_radius / m);
    }
    customViewOffset = vector_add(customViewOffset, customViewRotationCenter);
}

cycleNextMultiFunctionDisplay:

- (void) cycleNextMultiFunctionDisplay:

(NSUInteger)

index

Definition at line 13727 of file PlayerEntity.m.

                                      :(NSUInteger) index
{
    if ([[self hud] mfdCount] == 0) return;
    NSArray *keys = [multiFunctionDisplayText allKeys];
    NSString *key = nil;
    if ([keys count] == 0)
    {
        [self setMultiFunctionDisplay:index toKey:nil];
        return;
    }
    id current = [multiFunctionDisplaySettings objectAtIndex:index];
    if (current == [NSNull null])
    {
        key = [keys objectAtIndex:0];
        [self setMultiFunctionDisplay:index toKey:key];
    }
    else
    {
        NSUInteger cIndex = [keys indexOfObject:current];
        if (cIndex == NSNotFound || cIndex + 1 >= [keys count])
        {
            key = nil;
            [self setMultiFunctionDisplay:index toKey:nil];
        }
        else 
        {
            key = [keys objectAtIndex:(cIndex+1)];
            [self setMultiFunctionDisplay:index toKey:key];
        }
    }
    JSContext *context = OOJSAcquireContext();
    jsval keyVal = OOJSValueFromNativeObject(context,key);
    ShipScriptEvent(context, self, "mfdKeyChanged", INT_TO_JSVAL(activeMFD), keyVal);
    OOJSRelinquishContext(context);
}

cyclePreviousMultiFunctionDisplay:

- (void) cyclePreviousMultiFunctionDisplay:

(NSUInteger)

index

Definition at line 13727 of file PlayerEntity.m.

                                          :(NSUInteger) index
{
    if ([[self hud] mfdCount] == 0) return;
    NSArray *keys = [multiFunctionDisplayText allKeys];
    NSString *key = nil;
    if ([keys count] == 0)
    {
        [self setMultiFunctionDisplay:index toKey:nil];
        return;
    }
    id current = [multiFunctionDisplaySettings objectAtIndex:index];
    if (current == [NSNull null])
    {
        key = [keys objectAtIndex:([keys count]-1)];
        [self setMultiFunctionDisplay:index toKey:key];
    }
    else
    {
        NSUInteger cIndex = [keys indexOfObject:current];
        if (cIndex == NSNotFound || cIndex == 0)
        {
            key = nil;
            [self setMultiFunctionDisplay:index toKey:nil];
        }
        else 
        {
            key = [keys objectAtIndex:(cIndex-1)];
            [self setMultiFunctionDisplay:index toKey:key];
        }
    }
    JSContext *context = OOJSAcquireContext();
    jsval keyVal = OOJSValueFromNativeObject(context,key);
    ShipScriptEvent(context, self, "mfdKeyChanged", INT_TO_JSVAL(activeMFD), keyVal);
    OOJSRelinquishContext(context);
}

d100_number

- (NSNumber *) d100_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    int d100 = ranrot_rand() % 100;
    return [NSNumber numberWithInt:d100];
}

d256_number

- (NSNumber *) d256_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    int d256 = ranrot_rand() % 256;
    return [NSNumber numberWithInt:d256];
}

deactivateCloakingDevice

- (void) deactivateCloakingDevice

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    if (![self hasCloakingDevice])  return;
 
    [super deactivateCloakingDevice];
    [UNIVERSE terminatePostFX:OO_POSTFX_CLOAK];
    [UNIVERSE addMessage:DESC(@"cloak-off") forCount:2];
    [self playCloakingDeviceOff];
}

dealloc

- (void) dealloc

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    DESTROY(compassTarget);
    DESTROY(hud);
    DESTROY(multiFunctionDisplayText);
    DESTROY(multiFunctionDisplaySettings);
    DESTROY(customDialSettings);
 
    DESTROY(commLog);
    DESTROY(keyconfig2_settings);
    DESTROY(target_memory);
    
    DESTROY(_fastEquipmentA);
    DESTROY(_fastEquipmentB);
 
    DESTROY(eqScripts);
    DESTROY(worldScripts);
    DESTROY(worldScriptsRequiringTickle);
    DESTROY(commodityScripts);
    DESTROY(mission_variables);
    
    DESTROY(localVariables);
    
    DESTROY(lastTextKey);
    
    DESTROY(marketSelectedCommodity);
    DESTROY(reputation);
    DESTROY(roleWeights);
    DESTROY(roleWeightFlags);
    DESTROY(roleSystemList);
    DESTROY(passengers);
    DESTROY(passenger_record);
    DESTROY(contracts);
    DESTROY(contract_record);
    DESTROY(parcels);
    DESTROY(parcel_record);
    DESTROY(missionDestinations);
    DESTROY(shipyard_record);
    
    DESTROY(_missionOverlayDescriptor);
    DESTROY(_missionBackgroundDescriptor);
    DESTROY(_equipScreenBackgroundDescriptor);
    
    DESTROY(_commanderName);
    DESTROY(_lastsaveName);
    DESTROY(shipCommodityData);
    
    DESTROY(specialCargo);
    
    DESTROY(save_path);
    DESTROY(scenarioKey);
    
    DESTROY(_customViews);
    DESTROY(lastShot);
 
    DESTROY(dockingReport);
    
    DESTROY(_jumpCause);
 
    [self destroySound];
    
    DESTROY(scannedWormholes);
    DESTROY(wormhole);
    
    int i;
    for (i = 0; i < PLAYER_MAX_MISSILES; i++)  DESTROY(missile_entity[i]);
    for (i = 0; i < PLAYER_MAX_TRUMBLES; i++)  DESTROY(trumble[i]);
    
    DESTROY(keyShiftText);
    DESTROY(keyMod1Text);
    DESTROY(keyMod2Text);
    DESTROY(stickFunctions);
    DESTROY(keyFunctions);
    DESTROY(kbdLayouts);
 
    DESTROY(customEquipActivation);
    DESTROY(customActivatePressed);
    DESTROY(customModePressed);
 
    DESTROY(extraGuiScreenKeys);
 
    [super dealloc];
}

debugMessage:

- (void) debugMessage:

(NSString *)

args

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                     :(NSString *)args
{
    OOLog(kOOLogDebugMessage, @"SCRIPT debugMessage: %@", args);
}

debugOff

- (void) debugOff

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    OOLog(kOOLogDebugOnOff, @"%@", @"SCRIPT debug messages OFF");
    OOLogSetDisplayMessagesInClass(kOOLogDebugOnMetaClass, NO);
}

debugOn

- (void) debugOn

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    OOLogSetDisplayMessagesInClass(kOOLogDebugOnMetaClass, YES);
    OOLog(kOOLogDebugOnOff, @"%@", @"SCRIPT debug messages ON");
}

deciCredits

- (OOCreditsQuantity) deciCredits

Definition at line 13727 of file PlayerEntity.m.

{
    return credits;
}

decreaseContractReputation:

- (void) decreaseContractReputation:

(unsigned)

amount

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                                   :(unsigned)amount
{
    int good = [reputation oo_intForKey:CONTRACTS_GOOD_KEY];
    int bad = [reputation oo_intForKey:CONTRACTS_BAD_KEY];
    int unknown = [reputation oo_intForKey:CONTRACTS_UNKNOWN_KEY];
    
    for (unsigned i=0;i<amount;i++)
    {
    if (good > 0)
    {
        // shift a bean from good to bad
        good--;
        if (bad < MAX_CONTRACT_REP)
            bad++;
    }
    else
    {
        // shift a bean from unknown to bad
        if (unknown > 0)
            unknown--;
        if (bad < MAX_CONTRACT_REP)
            bad++;
    }
    }
    [reputation oo_setInteger:good      forKey:CONTRACTS_GOOD_KEY];
    [reputation oo_setInteger:bad       forKey:CONTRACTS_BAD_KEY];
    [reputation oo_setInteger:unknown   forKey:CONTRACTS_UNKNOWN_KEY];
}

decreaseParcelReputation:

- (void) decreaseParcelReputation:

(unsigned)

amount

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                                 :(unsigned)amount
{
    int good = [reputation oo_intForKey:PARCEL_GOOD_KEY];
    int bad = [reputation oo_intForKey:PARCEL_BAD_KEY];
    int unknown = [reputation oo_intForKey:PARCEL_UNKNOWN_KEY];
    
    for (unsigned i=0;i<amount;i++)
    {
    if (good > 0)
    {
        // shift a bean from good to bad
        good--;
        if (bad < MAX_CONTRACT_REP)
            bad++;
    }
    else
    {
        // shift a bean from unknown to bad
        if (unknown > 0)
            unknown--;
        if (bad < MAX_CONTRACT_REP)
            bad++;
    }
    }
    [reputation oo_setInteger:good      forKey:PARCEL_GOOD_KEY];
    [reputation oo_setInteger:bad       forKey:PARCEL_BAD_KEY];
    [reputation oo_setInteger:unknown   forKey:PARCEL_UNKNOWN_KEY];
}

decreasePassengerReputation:

- (void) decreasePassengerReputation:

(unsigned)

amount

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                                    :(unsigned)amount
{
    int good = [reputation oo_intForKey:PASSAGE_GOOD_KEY];
    int bad = [reputation oo_intForKey:PASSAGE_BAD_KEY];
    int unknown = [reputation oo_intForKey:PASSAGE_UNKNOWN_KEY];
    
for (unsigned i=0;i<amount;i++)
    {
    if (good > 0)
    {
        // shift a bean from good to bad
        good--;
        if (bad < MAX_CONTRACT_REP)
            bad++;
    }
    else
    {
        // shift a bean from unknown to bad
        if (unknown > 0)
            unknown--;
        if (bad < MAX_CONTRACT_REP)
            bad++;
    }
    }
    [reputation oo_setInteger:good      forKey:PASSAGE_GOOD_KEY];
    [reputation oo_setInteger:bad       forKey:PASSAGE_BAD_KEY];
    [reputation oo_setInteger:unknown   forKey:PASSAGE_UNKNOWN_KEY];
}

decrement:

- (void) decrement:

(NSString *)

missionVariableString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *)missionVariableString
{
    BOOL hasMissionPrefix, hasLocalPrefix;
    int value = 0;
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
    
    if (hasMissionPrefix)
    {
        value = [[self missionVariableForKey:missionVariableString] intValue];
        value--;
        [self setMissionVariable:[NSString stringWithFormat:@"%d", value] forKey:missionVariableString];
    }
    else if (hasLocalPrefix)
    {
        value = [[self localVariableForKey:missionVariableString andMission:sCurrentMissionKey] intValue];
        value--;
        [self setLocalVariable:[NSString stringWithFormat:@"%d", value] forKey:missionVariableString andMission:sCurrentMissionKey];
    }
    else
    {
        OOLog(kOOLogSyntaxDecrement, @"***** SCRIPT ERROR: in %@, IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString);
    }
}

defaultMarker:

- (NSDictionary *) defaultMarker:

(OOSystemID)

system

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                :(OOSystemID)system
{
    return [[[NSDictionary dictionaryWithObjectsAndKeys:
                                [NSNumber numberWithInt:system], @"system",
                                MISSION_DEST_LEGACY, @"name",
                                @"redColor", @"markerColor",
                                @"MARKER_X", @"markerShape",
                                nil] retain] autorelease];
}

Referenced by MissionMarkSystem(), and MissionUnmarkSystem().

Here is the caller graph for this function:

deferredInit

- (void) deferredInit

Definition at line 13727 of file PlayerEntity.m.

{
    NSAssert(gOOPlayer == self, @"Expected only one PlayerEntity to exist at a time.");
    NSAssert([super initWithKey:PLAYER_SHIP_DESC definition:[NSDictionary dictionary]] == self, @"PlayerEntity requires -[ShipEntity initWithKey:definition:] to return unmodified self.");
 
    maxFieldOfView = MAX_FOV;
#if OO_FOV_INFLIGHT_CONTROL_ENABLED
    fov_delta = 2.0; // multiply by 2 each second
#endif
    
    compassMode = COMPASS_MODE_BASIC;
    
    afterburnerSoundLooping = NO;
    
    isPlayer = YES;
    
    [self setStatus:STATUS_START_GAME];
 
    int i;
    for (i = 0; i < PLAYER_MAX_MISSILES; i++)
    {
        missile_entity[i] = nil;
    }
    [self setUpAndConfirmOK:NO];
    
    save_path = nil;
    
    scoopsActive = NO;
    
    target_memory_index = 0;
    
    DESTROY(dockingReport);
    dockingReport = [[NSMutableString alloc] init];
    [hud resetGuis:[NSDictionary dictionaryWithObjectsAndKeys:[NSDictionary dictionary], @"message_gui",
                                                        [NSDictionary dictionary], @"comm_log_gui", nil]];
    
    [self initControls];
}

deleteAllKeySettings

- (void) deleteAllKeySettings

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

{
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    [defaults removeObjectForKey:KEYCONFIG_OVERRIDES];
    if ([customEquipActivation count] > 0)
    {
        NSUInteger i;
        for (i = 0; i < [customEquipActivation count]; i++)
        {
            NSString *eq = [[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPKEY];
            OOEquipmentType *item = [OOEquipmentType equipmentTypeWithIdentifier:eq];
            if ([item defaultActivateKey]) 
                [[customEquipActivation objectAtIndex:i] setObject:[item defaultActivateKey] forKey:CUSTOMEQUIP_KEYACTIVATE];
            else
                [[customEquipActivation objectAtIndex:i] removeObjectForKey:CUSTOMEQUIP_KEYACTIVATE];
 
            if ([item defaultModeKey])
                [[customEquipActivation objectAtIndex:i] setObject:[item defaultModeKey] forKey:CUSTOMEQUIP_KEYMODE];
            else
                [[customEquipActivation objectAtIndex:i] removeObjectForKey:CUSTOMEQUIP_KEYMODE];
        }
        [defaults setObject:customEquipActivation forKey:KEYCONFIG_CUSTOMEQUIP];
    }
    // reload settings
    [self initKeyConfigSettings];
}

deleteKeySetting:

- (void) deleteKeySetting: (NSString*)  key

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                         :(NSString*)key
{
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    if (![self entryIsCustomEquip:key])
    {
        NSMutableDictionary *keyconf = [NSMutableDictionary dictionaryWithDictionary:[defaults objectForKey:KEYCONFIG_OVERRIDES]];
        [keyconf removeObjectForKey:key];
        [defaults setObject:keyconf forKey:KEYCONFIG_OVERRIDES];
    }
    else 
    {
        NSString *custkey = [self getCustomEquipKeyDefType:key];
        [[customEquipActivation objectAtIndex:[self getCustomEquipIndex:key]] removeObjectForKey:custkey];
        [defaults setObject:customEquipActivation forKey:KEYCONFIG_CUSTOMEQUIP];
    }
    // reload settings
    [self initKeyConfigSettings];
}

describeStickDict:

- (NSString *) describeStickDict: (NSDictionary *)  stickDict

implementation

Provided by category PlayerEntity(StickMapperInternal).

Definition at line 1 of file PlayerEntityStickMapper.m.

                                : (NSDictionary *)stickDict
{
    NSString *desc=nil;
    if(stickDict)
    {
        int thingNumber=[(NSNumber *)[stickDict objectForKey: STICK_AXBUT]
                         intValue];
        int stickNumber=[(NSNumber *)[stickDict objectForKey: STICK_NUMBER]
                         intValue];
        // Button or axis?
        if([(NSNumber *)[stickDict objectForKey: STICK_ISAXIS] boolValue])
        {
            desc=[NSString stringWithFormat: @"Stick %d axis %d",
                  stickNumber+1, thingNumber+1];
        }
        else if(thingNumber >= MAX_REAL_BUTTONS)
        {
            static const char dir[][6] = { "up", "right", "down", "left" };
            desc=[NSString stringWithFormat: @"Stick %d hat %d %s",
                  stickNumber+1, (thingNumber - MAX_REAL_BUTTONS) / 4 + 1,
                  dir[thingNumber & 3]];
        }
        else
        {
            desc=[NSString stringWithFormat: @"Stick %d button %d",
                  stickNumber+1, thingNumber+1];
        }
    }
    return desc;
}

destroySound

- (void) destroySound

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    DESTROY(sInterfaceBeepSource);
    DESTROY(sBreakPatternSource);
    DESTROY(sEcmSource);
    DESTROY(sHyperspaceSoundSource);
    
    DESTROY(sAfterburnerSources[0]);
    DESTROY(sAfterburnerSources[1]);
 
    DESTROY(sBuySellSourcePool);
    DESTROY(sWarningSoundPool);
    DESTROY(sWeaponSoundPool);
    DESTROY(sDamageSoundPool);
    DESTROY(sMiscSoundPool);
 
    DESTROY(weaponShotMiss);
    DESTROY(weaponShotHit);
    DESTROY(weaponShieldHit);
    DESTROY(weaponUnshieldedHit);
    DESTROY(weaponLaunched);
}

dial_clock

- (NSString *) dial_clock

Definition at line 13727 of file PlayerEntity.m.

{
    return ClockToString(ship_clock, ship_clock_adjust > 0);
}

dial_clock_adjusted

- (NSString *) dial_clock_adjusted

Definition at line 13727 of file PlayerEntity.m.

{
    return ClockToString(ship_clock + ship_clock_adjust, NO);
}

dial_fpsinfo

- (NSString *) dial_fpsinfo

Definition at line 13727 of file PlayerEntity.m.

{
    unsigned fpsVal = fps_counter;  
    return [NSString stringWithFormat:@"FPS: %3d", fpsVal];
}

dial_objinfo

- (NSString *) dial_objinfo

Definition at line 13727 of file PlayerEntity.m.

{
    NSString *result = [NSString stringWithFormat:@"Entities: %3llu", [UNIVERSE entityCount]];
#ifndef NDEBUG
    result = [NSString stringWithFormat:@"%@ (%d, %zu KiB, avg %zu bytes)", result, gLiveEntityCount, gTotalEntityMemory >> 10, gTotalEntityMemory / gLiveEntityCount];
#endif
    
    return result;
}

dialAftShield

- (GLfloat) dialAftShield

Definition at line 13727 of file PlayerEntity.m.

{
    if (EXPECT_NOT([self maxAftShieldLevel] <= 0))
    {
        return 0.0;
    }
    GLfloat result = aft_shield / [self maxAftShieldLevel];
    return OOClamp_0_1_f(result);
}

dialAltitude

- (GLfloat) dialAltitude

Definition at line 13727 of file PlayerEntity.m.

{
    if ([self isDocked])  return 0.0f;
    
    // find nearest planet type entity...
    assert(UNIVERSE != nil);
    
    Entity  *nearestPlanet = [self findNearestStellarBody];
    if (nearestPlanet == nil)  return 1.0f;
    
    GLfloat zd = nearestPlanet->zero_distance;
    GLfloat cr = nearestPlanet->collision_radius;
    GLfloat alt = sqrt(zd) - cr;
    
    return OOClamp_0_1_f(alt / (GLfloat)PLAYER_DIAL_MAX_ALTITUDE);
}

dialCustomColor:

- (OOColor *) dialCustomColor:

(NSString *)

dialKey

Definition at line 13727 of file PlayerEntity.m.

                             :(NSString *)dialKey
{
    return [OOColor colorWithDescription:[customDialSettings objectForKey:dialKey]];
}

dialCustomFloat:

- (float) dialCustomFloat:

(NSString *)

dialKey

Definition at line 13727 of file PlayerEntity.m.

                         :(NSString *)dialKey
{
    return [customDialSettings oo_floatForKey:dialKey defaultValue:0.0];
}

dialCustomString:

- (NSString *) dialCustomString:

(NSString *)

dialKey

Definition at line 13727 of file PlayerEntity.m.

                               :(NSString *)dialKey
{
    return [customDialSettings oo_stringForKey:dialKey defaultValue:@""];
}

dialEnergy

- (GLfloat) dialEnergy

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat result = energy / maxEnergy;
    return OOClamp_0_1_f(result);
}

dialForwardShield

- (GLfloat) dialForwardShield

Definition at line 13727 of file PlayerEntity.m.

{
    if (EXPECT_NOT([self maxForwardShieldLevel] <= 0))
    {
        return 0.0;
    }
    GLfloat result = forward_shield / [self maxForwardShieldLevel];
    return OOClamp_0_1_f(result);
}

dialFuel

- (GLfloat) dialFuel

Definition at line 13727 of file PlayerEntity.m.

{
    if (fuel <= 0.0f)
        return 0.0f;
    if (fuel > [self fuelCapacity])
        return 1.0f;
    return (GLfloat)fuel / (GLfloat)[self fuelCapacity];
}

dialFuelScoopStatus

- (OOFuelScoopStatus) dialFuelScoopStatus

Definition at line 13727 of file PlayerEntity.m.

{
    // need to account for the different ways of calculating cargo on board when docked/in-flight
    OOCargoQuantity cargoOnBoard = [self status] == STATUS_DOCKED ? current_cargo : (OOCargoQuantity)[cargo count];
    if ([self hasScoop])
    {
        if (scoopsActive)
            return SCOOP_STATUS_ACTIVE;
        if (cargoOnBoard >= [self maxAvailableCargoSpace] || specialCargo)
            return SCOOP_STATUS_FULL_HOLD;
        return SCOOP_STATUS_OKAY;
    }
    else
    {
        return SCOOP_STATUS_NOT_INSTALLED;
    }
}

dialHyperRange

- (GLfloat) dialHyperRange

Definition at line 13727 of file PlayerEntity.m.

{
    if (target_system_id == system_id && ![UNIVERSE inInterstellarSpace])  return 0.0f;
    return [self fuelRequiredForJump] / (GLfloat)PLAYER_MAX_FUEL;
}

dialHyperSpeed

- (GLfloat) dialHyperSpeed

Definition at line 13727 of file PlayerEntity.m.

{
    return flightSpeed / maxFlightSpeed;
}

dialIdentEngaged

- (BOOL) dialIdentEngaged

Definition at line 13727 of file PlayerEntity.m.

{
    return ident_engaged;
}

dialMaxEnergy

- (GLfloat) dialMaxEnergy

Definition at line 13727 of file PlayerEntity.m.

{
    return maxEnergy;
}

dialMaxMissiles

- (NSUInteger) dialMaxMissiles

Definition at line 13727 of file PlayerEntity.m.

{
    return max_missiles;
}

dialMissileStatus

- (OOMissileStatus) dialMissileStatus

Definition at line 13727 of file PlayerEntity.m.

{
    if ([self weaponsOnline])
    {
        return missile_status;
    }
    else
    {
        // Invariant/safety interlock: weapons offline implies missiles safe. -- Ahruman 2012-07-21
        if (missile_status != MISSILE_STATUS_SAFE)
        {
            OOLogERR(@"player.missilesUnsafe", @"%@", @"Missile state is not SAFE when weapons are offline. This is a bug, please report it.");
            [self safeAllMissiles];
        }
        return MISSILE_STATUS_SAFE;
    }
}

dialPitch

- (GLfloat) dialPitch

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat result = flightPitch / max_flight_pitch;
    if ((result < 1.0f)&&(result > -1.0f))
        return result;
    if (result > 0.0f)
        return 1.0f;
    return -1.0f;
}

dialRoll

- (GLfloat) dialRoll

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat result = flightRoll / max_flight_roll;
    if ((result < 1.0f)&&(result > -1.0f))
        return result;
    if (result > 0.0f)
        return 1.0f;
    return -1.0f;
}

dialSpeed

- (GLfloat) dialSpeed

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat result = flightSpeed / maxFlightSpeed;
    return OOClamp_0_1_f(result);
}

dialTargetName

- (NSString *) dialTargetName

Definition at line 13727 of file PlayerEntity.m.

{
    Entity      *target_entity = [self primaryTarget];
    NSString    *result = nil;
    
    if (target_entity == nil)
    {
        result = DESC(@"no-target-string");
    }
    
    if ([target_entity respondsToSelector:@selector(identFromShip:)])
    {
        result = [(ShipEntity*)target_entity identFromShip:self];
    }
    
    if (result == nil)  result = DESC(@"unknown-target");
    
    return result;
}

dialYaw

- (GLfloat) dialYaw

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat result = -flightYaw / max_flight_yaw;
    if ((result < 1.0f)&&(result > -1.0f))
    return result;
    if (result > 0.0f)
        return 1.0f;
    return -1.0f;
}

disengageAutopilot

- (void) disengageAutopilot

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    if (autopilot_engaged)
    {
        [self abortDocking];            // let the station know that you are no longer on approach
        behaviour = BEHAVIOUR_IDLE;
        frustration = 0.0;
        autopilot_engaged = NO;
        DESTROY(_primaryTarget);
        [self setTargetStation:nil];
        [self setStatus:STATUS_IN_FLIGHT];
        [self playAutopilotOff];
        [self setDockingClearanceStatus:DOCKING_CLEARANCE_STATUS_NONE];
        [[OOMusicController sharedController] stopDockingMusic];
        [self doScriptEvent:OOJSID("playerCancelledAutoPilot")];
        
        [self resetAutopilotAI];
    }
}

Referenced by PlayerEntity(OOControlsPrivate)::handleAutopilotOn:.

Here is the caller graph for this function:

displayFunctionList:skip:

- (void) displayFunctionList: (GuiDisplayGen *)  gui skip: (NSUInteger)  skip

implementation

Provided by category PlayerEntity(StickMapperInternal).

Definition at line 1 of file PlayerEntityStickMapper.m.

                            :(GuiDisplayGen *)gui
                        skip:(NSUInteger)skip
{
    OOJoystickManager   *stickHandler = [OOJoystickManager sharedStickHandler];
    
    [gui setColor:[OOColor greenColor] forRow: GUI_ROW_HEADING];
    [gui setArray:[NSArray arrayWithObjects:
                   @"Function", @"Assigned to", @"Type", nil]
           forRow:GUI_ROW_HEADING];
    
    if(!stickFunctions)
    {
        stickFunctions = [[self stickFunctionList] retain];
    }
    NSDictionary *assignedAxes = [stickHandler axisFunctions];
    NSDictionary *assignedButs = [stickHandler buttonFunctions];
    
    NSUInteger i, n_functions = [stickFunctions count];
    NSInteger n_rows, start_row, previous = 0;
    
    if (skip >= n_functions)
        skip = n_functions - 1;
    
    if (n_functions < MAX_ROWS_FUNCTIONS)
    {
        skip = 0;
        previous = 0;
        n_rows = MAX_ROWS_FUNCTIONS;
        start_row = GUI_ROW_FUNCSTART;
    }
    else
    {
        n_rows = MAX_ROWS_FUNCTIONS  - 1;
        start_row = GUI_ROW_FUNCSTART;
        if (skip > 0)
        {
            n_rows -= 1;
            start_row += 1;
            if (skip > MAX_ROWS_FUNCTIONS)
                previous = skip - (MAX_ROWS_FUNCTIONS - 2);
            else
                previous = 0;
        }
    }
    
    if (n_functions > 0)
    {
        if (skip > 0)
        {
            [gui setColor:[OOColor greenColor] forRow:GUI_ROW_FUNCSTART];
            [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-back"), @" <-- ", nil] forRow:GUI_ROW_FUNCSTART];
            [gui setKey:[NSString stringWithFormat:@"More:%lld", previous] forRow:GUI_ROW_FUNCSTART];
        }
        
        for(i=0; i < (n_functions - skip) && (int)i < n_rows; i++)
        {
            NSDictionary *entry = [stickFunctions objectAtIndex: i + skip];
            if ([entry objectForKey:KEY_HEADER]) {
                NSString *header = [entry objectForKey:KEY_HEADER];
                [gui setArray:[NSArray arrayWithObjects:header, @"", @"", nil] forRow:i + start_row];
                [gui setColor:[OOColor cyanColor] forRow:i + start_row];
            }
            else
            {
                NSString *allowedThings;
                NSString *assignment;
                NSString *axFuncKey = [entry oo_stringForKey:KEY_AXISFN];
                NSString *butFuncKey = [entry oo_stringForKey:KEY_BUTTONFN];
                int allowable = [entry oo_intForKey:KEY_ALLOWABLE];
                switch(allowable)
                {
                    case HW_AXIS:
                        allowedThings=@"Axis";
                        assignment=[self describeStickDict:
                                    [assignedAxes objectForKey: axFuncKey]];
                        break;
                    case HW_BUTTON:
                        allowedThings=@"Button";
                        int bf = [butFuncKey integerValue];
                        if (bf < 10000) 
                        {
                            assignment=[self describeStickDict:
                                        [assignedButs objectForKey: butFuncKey]];
                        } 
                        else 
                        {
                            NSString *key = CUSTOMEQUIP_BUTTONACTIVATE;
                            bf -= 10000;
                            if (bf >= 10000) 
                            {
                                bf -= 10000;
                                key = CUSTOMEQUIP_BUTTONMODE;
                            }
                            assignment=[self describeStickDict:
                                            [[customEquipActivation objectAtIndex:bf] objectForKey:key]];
                        }
                        break;
                    default:
                        allowedThings=@"Axis/Button";
                        
                        // axis has priority
                        assignment=[self describeStickDict:
                                    [assignedAxes objectForKey: axFuncKey]];
                        if(!assignment)
                            assignment=[self describeStickDict:
                                        [assignedButs objectForKey: butFuncKey]];
                }
                
                // Find out what's assigned for this function currently.
                if (assignment == nil)
                {
                    assignment = @"   -   ";
                }
                
                [gui setArray: [NSArray arrayWithObjects: 
                                [entry objectForKey: KEY_GUIDESC], assignment, allowedThings, nil]
                    forRow: i + start_row];
                //[gui setKey: GUI_KEY_OK forRow: i + start_row];
                [gui setKey: [NSString stringWithFormat: @"Index:%llu", i + skip] forRow: i + start_row];
            }
        }
        if (i < n_functions - skip)
        {
            [gui setColor: [OOColor greenColor] forRow: start_row + i];
            [gui setArray: [NSArray arrayWithObjects: DESC(@"gui-more"), @" --> ", nil] forRow: start_row + i];
            [gui setKey: [NSString stringWithFormat: @"More:%llu", n_rows + skip] forRow: start_row + i];
            i++;
        }
        
        [gui setSelectableRange: NSMakeRange(GUI_ROW_STICKPROFILE, i + start_row - GUI_ROW_STICKPROFILE)];
    }
    
}

displayKeyboardLayoutList:skip:

- (void) displayKeyboardLayoutList: (GuiDisplayGen *)  gui skip: (NSUInteger)  skip

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                  :(GuiDisplayGen *)gui skip:(NSUInteger)skip
{
    [gui setColor:[OOColor greenColor] forRow:GUI_ROW_KC_HEADING];
    [gui setArray:[NSArray arrayWithObjects:@"Keyboard layout", nil] forRow:GUI_ROW_KC_HEADING];
 
    if (!kbdLayouts) kbdLayouts = [[self keyboardLayoutList] retain];
 
    NSUInteger i, n_functions = [kbdLayouts count];
    NSInteger n_rows, start_row, previous = 0;
 
    if (skip >= n_functions)
        skip = n_functions - 1;
    
    if (n_functions < MAX_ROWS_KC_FUNCTIONS)
    {
        skip = 0;
        previous = 0;
        n_rows = MAX_ROWS_KC_FUNCTIONS;
        start_row = GUI_ROW_KC_FUNCSTART;
    }
    else
    {
        n_rows = MAX_ROWS_KC_FUNCTIONS  - 1;
        start_row = GUI_ROW_KC_FUNCSTART;
        if (skip > 0)
        {
            n_rows -= 1;
            start_row += 1;
            if (skip > MAX_ROWS_KC_FUNCTIONS)
                previous = skip - (MAX_ROWS_KC_FUNCTIONS - 2);
            else
                previous = 0;
        }
    }
    
    if (n_functions > 0)
    {
        if (skip > 0)
        {
            [gui setColor:[OOColor greenColor] forRow:GUI_ROW_KC_FUNCSTART];
            [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-back"), @" <-- ", nil] forRow:GUI_ROW_KC_FUNCSTART];
            [gui setKey:[NSString stringWithFormat:@"More:%lld", previous] forRow:GUI_ROW_KC_FUNCSTART];
        }
        
        NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
        NSString *kbd = [defaults oo_stringForKey:@"keyboard-code" defaultValue:@"default"];
 
        for(i = 0; i < (n_functions - skip) && (int)i < n_rows; i++)
        {
            NSDictionary *entry = [kbdLayouts objectAtIndex:i + skip];
            NSString *desc = [entry objectForKey:@"description"];
            NSString *selected = @"";
            if ([[entry objectForKey:@"key"] isEqualToString:kbd]) selected = @"Current";
            [gui setArray:[NSArray arrayWithObjects:desc, selected, nil] forRow:i + start_row];
            [gui setKey:[NSString stringWithFormat:@"Index:%llu", i + skip] forRow:i + start_row];
        }
        if (i < n_functions - skip)
        {
            [gui setColor:[OOColor greenColor] forRow:start_row + i];
            [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-more"), @" --> ", nil] forRow:start_row + i];
            [gui setKey:[NSString stringWithFormat:@"More:%llu", n_rows + skip] forRow:start_row + i];
            i++;
        }
        
        [gui setSelectableRange:NSMakeRange(GUI_ROW_KC_FUNCSTART, i + start_row - GUI_ROW_KC_FUNCSTART)];
    }
}

displayKeyFunctionList:skip:

- (void) displayKeyFunctionList: (GuiDisplayGen *)  gui skip: (NSUInteger)  skip

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                               :(GuiDisplayGen *)gui skip:(NSUInteger)skip
{
    [gui setColor:[OOColor greenColor] forRow:GUI_ROW_KC_HEADING];
    [gui setArray:[NSArray arrayWithObjects:
                   @"Function", @"Assigned to", @"Overrides", nil]
           forRow:GUI_ROW_KC_HEADING];
 
    NSDictionary *overrides = [self loadKeySettings];
 
    if(!keyFunctions)
    {
        keyFunctions = [[self keyFunctionList] retain];
    }
 
    NSUInteger i, n_functions = [keyFunctions count];
    NSInteger n_rows, start_row, previous = 0;
    NSString *validate = nil;
 
    if (skip >= n_functions)
        skip = n_functions - 1;
    
    if (n_functions < MAX_ROWS_KC_FUNCTIONS)
    {
        skip = 0;
        previous = 0;
        n_rows = MAX_ROWS_KC_FUNCTIONS;
        start_row = GUI_ROW_KC_FUNCSTART;
    }
    else
    {
        n_rows = MAX_ROWS_KC_FUNCTIONS  - 1;
        start_row = GUI_ROW_KC_FUNCSTART;
        if (skip > 0)
        {
            n_rows -= 1;
            start_row += 1;
            if (skip > MAX_ROWS_KC_FUNCTIONS)
                previous = skip - (MAX_ROWS_KC_FUNCTIONS - 2);
            else
                previous = 0;
        }
    }
    
    if (n_functions > 0)
    {
        if (skip > 0)
        {
            [gui setColor:[OOColor greenColor] forRow:GUI_ROW_KC_FUNCSTART];
            [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-back"), @" <-- ", nil] forRow:GUI_ROW_KC_FUNCSTART];
            [gui setKey:[NSString stringWithFormat:@"More:%lld", previous] forRow:GUI_ROW_KC_FUNCSTART];
        }
        
        for(i = 0; i < (n_functions - skip) && (int)i < n_rows; i++)
        {
            NSDictionary *entry = [keyFunctions objectAtIndex:i + skip];
            if ([entry objectForKey:KEY_KC_HEADER]) {
                NSString *header = [entry objectForKey:KEY_KC_HEADER];
                [gui setArray:[NSArray arrayWithObjects:header, @"", @"", nil] forRow:i + start_row];
                [gui setColor:[OOColor cyanColor] forRow:i + start_row];
            }
            else
            {
                NSString *assignment = nil;
                NSString *override = nil;
                if (![self entryIsDictCustomEquip:entry])
                {
                    // Find out what's assigned for this function currently.
                    assignment = [PLAYER keyBindingDescription2:[entry objectForKey:KEY_KC_DEFINITION]];
                    override = ([overrides objectForKey:[entry objectForKey:KEY_KC_DEFINITION]] ? @"Yes" : @""); // work out whether this assignment is overriding the setting in keyconfig2.plist
                    validate = [self validateKey:[entry objectForKey:KEY_KC_DEFINITION] checkKeys:(NSArray *)[keyconfig2_settings objectForKey:[entry objectForKey:KEY_KC_DEFINITION]]];
                }
                else 
                {
                    NSString *custom_keytype = [self getCustomEquipKeyDefType:[entry oo_stringForKey:KEY_KC_DEFINITION]];
                    NSUInteger idx = [self getCustomEquipIndex:[entry oo_stringForKey:KEY_KC_DEFINITION]];
                    assignment = [PLAYER getKeyBindingDescription:[[customEquipActivation objectAtIndex:idx] oo_arrayForKey:custom_keytype]];
                    OOEquipmentType *item = [OOEquipmentType equipmentTypeWithIdentifier:[[customEquipActivation objectAtIndex:idx] oo_stringForKey:CUSTOMEQUIP_EQUIPKEY]];
                    bool result = true;
                    int j, k;
                    NSArray *defArray = nil;
                    NSArray *compArray = nil;
 
                    if ([custom_keytype isEqualToString:CUSTOMEQUIP_KEYACTIVATE]) 
                    {
                        defArray = [item defaultActivateKey];
                        compArray = [[customEquipActivation objectAtIndex:idx] oo_arrayForKey:custom_keytype];
                    }
                    if ([custom_keytype isEqualToString:CUSTOMEQUIP_KEYMODE]) 
                    {
                        defArray = [item defaultModeKey];
                        compArray = [[customEquipActivation objectAtIndex:idx] oo_arrayForKey:custom_keytype];
                    }
                    for (j = 0; j < [defArray count]; j++) 
                    {
                        for (k = 0; k < [compArray count]; k++)
                        {
                            if (![self compareKeyEntries:[defArray objectAtIndex:j] second:[compArray objectAtIndex:k]])
                            {
                                result = false;
                                break;
                            }
                        }
                        if (result == false) break;
                    }
 
                    override = (!result ? @"Yes" : @"");
                    validate = [self validateKey:[entry objectForKey:KEY_KC_DEFINITION] checkKeys:(NSArray *)[[customEquipActivation objectAtIndex:idx] oo_arrayForKey:custom_keytype]];
                }
                if (assignment == nil)
                {
                    assignment = @"   -   ";
                }
                
                [gui setArray:[NSArray arrayWithObjects: 
                                [entry objectForKey:KEY_KC_GUIDESC], assignment, override, nil]
                    forRow:i + start_row];
                [gui setKey:[NSString stringWithFormat:@"Index:%llu", i + skip] forRow:i + start_row];
                if (validate) 
                {
                    [gui setColor:[OOColor orangeColor] forRow:i + start_row];
                }
            }
        }
        if (i < n_functions - skip)
        {
            [gui setColor:[OOColor greenColor] forRow:start_row + i];
            [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-more"), @" --> ", nil] forRow:start_row + i];
            [gui setKey:[NSString stringWithFormat:@"More:%llu", n_rows + skip] forRow:start_row + i];
            i++;
        }
        
        [gui setSelectableRange:NSMakeRange(GUI_ROW_KC_SELECTKBD, (i + start_row - GUI_ROW_KC_FUNCSTART) + (GUI_ROW_KC_FUNCSTART - GUI_ROW_KC_SELECTKBD))];
    }
}

doBookkeeping:

- (void) doBookkeeping:

(double)

delta_t

This code branch doesn't seem to be used any more - see ~line 6000 Should we remove it? - CIM

Definition at line 13727 of file PlayerEntity.m.

                      :(double) delta_t
{
    STAGE_TRACKING_BEGIN
    
    double speed_delta = SHIP_THRUST_FACTOR * thrust;
 
    static BOOL     gettingInterference = NO;
    
    OOSunEntity *sun = [UNIVERSE sun];
    double      external_temp = 0;
    GLfloat     air_friction = 0.0f;
    air_friction = 0.5f * [UNIVERSE airResistanceFactor];
    if (air_friction < 0.005f) // aRF < 0.01
    {
        // stops mysteriously overheating and exploding in the middle of empty space
        air_friction = 0;
    }
 
    UPDATE_STAGE(@"updating weapon temperatures and shot times");
    // cool all weapons.
    float coolAmount = WEAPON_COOLING_FACTOR * delta_t;
    forward_weapon_temp = fdim(forward_weapon_temp, coolAmount);
    aft_weapon_temp = fdim(aft_weapon_temp, coolAmount);
    port_weapon_temp = fdim(port_weapon_temp, coolAmount);
    starboard_weapon_temp = fdim(starboard_weapon_temp, coolAmount);
    
    // update shot times.
    forward_shot_time += delta_t;
    aft_shot_time += delta_t;
    port_shot_time += delta_t;
    starboard_shot_time += delta_t;
        
    // copy new temp & shot time to main temp & shot time
    switch (currentWeaponFacing)
    {
        case WEAPON_FACING_FORWARD:
            weapon_temp = forward_weapon_temp;
            shot_time = forward_shot_time;
            break;
        case WEAPON_FACING_AFT:
            weapon_temp = aft_weapon_temp;
            shot_time = aft_shot_time;
            break;
        case WEAPON_FACING_PORT:
            weapon_temp = port_weapon_temp;
            shot_time = port_shot_time;
            break;
        case WEAPON_FACING_STARBOARD:
            weapon_temp = starboard_weapon_temp;
            shot_time = starboard_shot_time;
            break;
            
        case WEAPON_FACING_NONE:
            break;
    }
    
    // cloaking device
    if ([self hasCloakingDevice] && cloaking_device_active)
    {
        UPDATE_STAGE(@"updating cloaking device");
        
        energy -= (float)delta_t * CLOAKING_DEVICE_ENERGY_RATE;
        if (energy < CLOAKING_DEVICE_MIN_ENERGY)
            [self deactivateCloakingDevice];
    }
    
    // military_jammer
    if ([self hasMilitaryJammer])
    {
        UPDATE_STAGE(@"updating military jammer");
        
        if (military_jammer_active)
        {
            energy -= (float)delta_t * MILITARY_JAMMER_ENERGY_RATE;
            if (energy < MILITARY_JAMMER_MIN_ENERGY)
                military_jammer_active = NO;
        }
        else
        {
            if (energy > 1.5 * MILITARY_JAMMER_MIN_ENERGY)
                military_jammer_active = YES;
        }
    }
    
    // ecm
    if (ecm_in_operation)
    {
        UPDATE_STAGE(@"updating ECM");
        
        if (energy > 0.0)
            energy -= (float)(ECM_ENERGY_DRAIN_FACTOR * delta_t);       // drain energy because of the ECM
        else
        {
            ecm_in_operation = NO;
            [UNIVERSE addMessage:DESC(@"ecm-out-of-juice") forCount:3.0];
        }
        if ([UNIVERSE getTime] > ecm_start_time + ECM_DURATION)
        {
            ecm_in_operation = NO;
        }
    }
 
    // ecm interference visual effect
    if ([UNIVERSE useShaders] && [UNIVERSE ECMVisualFXEnabled])
    {
        // we want to start and stop the effect exactly once, not start it
        // or stop it on every frame
        if ([self scannerFuzziness] > 0.0)
        {
            if (!gettingInterference)
            {
                [UNIVERSE setCurrentPostFX:OO_POSTFX_CRTBADSIGNAL];
                gettingInterference = YES;
            }
        }
        else
        {
            if (gettingInterference)
            {
                [UNIVERSE terminatePostFX:OO_POSTFX_CRTBADSIGNAL];
                gettingInterference = NO;
            }
        }   
    }
    
    // Energy Banks and Shields
    
    /* Shield-charging behaviour, as per Eric's proposal:
       1. If shields are less than a threshold, recharge with all available energy
       2. If energy banks are below threshold, recharge with generated energy
       3. Charge shields with any surplus energy
    */
    UPDATE_STAGE(@"updating energy and shield charges");
    
    // 1. (Over)charge energy banks (will get normalised later)
    energy += [self energyRechargeRate] * delta_t;
    
    // 2. Calculate shield recharge rates
    float fwdMax = [self maxForwardShieldLevel];
    float aftMax = [self maxAftShieldLevel];
    float shieldRechargeFwd = [self forwardShieldRechargeRate] * delta_t;
    float shieldRechargeAft = [self aftShieldRechargeRate] * delta_t;
    /* there is potential for negative rechargeFwd and rechargeAFt values here
       (e.g. getting shield boosters damaged while shields are full). This may
       lead to energy being gained rather than consumed when recharging. Leaving
       as-is for now, as there might be OXPs that rely in such behaviour.
       Boosters case example mentioned above is the only known core equipment
       occurrence at this time and it has been fixed inside the
       oolite-equipment-control.js script. - Nikos 20160104.
     */
    float rechargeFwd = MIN(shieldRechargeFwd, fwdMax - forward_shield);
    float rechargeAft = MIN(shieldRechargeAft, aftMax - aft_shield);
    
    // Note: we've simplified this a little, so if either shield is below
    //       the critical threshold, we allocate all energy.  Ideally we
    //       would only allocate the full recharge to the critical shield,
    //       but doing so would add another few levels of if-then below.
    float energyForShields = energy;
    if( (forward_shield > fwdMax * 0.25) && (aft_shield > aftMax * 0.25) )
    {
        // TODO: Can this be cached anywhere sensibly (without adding another member variable)?
        float minEnergyBankLevel = [[UNIVERSE globalSettings] oo_floatForKey:@"shield_charge_energybank_threshold" defaultValue:0.25];
        energyForShields = MAX(0.0, energy -0.1 - (maxEnergy * minEnergyBankLevel)); // NB: The - 0.1 ensures the energy value does not 'bounce' across the critical energy message and causes spurious energy-low warnings
    }
    
    if( forward_shield < aft_shield )
    {
        rechargeFwd = MIN(rechargeFwd, energyForShields);
        rechargeAft = MIN(rechargeAft, energyForShields - rechargeFwd);
    }
    else
    {
        rechargeAft = MIN(rechargeAft, energyForShields);
        rechargeFwd = MIN(rechargeFwd, energyForShields - rechargeAft);
    }
    
    // 3. Recharge shields, drain banks, and clamp values
    forward_shield += rechargeFwd;
    aft_shield += rechargeAft;
    energy -= rechargeFwd + rechargeAft;
    
    forward_shield = OOClamp_0_max_f(forward_shield, fwdMax);
    aft_shield = OOClamp_0_max_f(aft_shield, aftMax);
    energy = OOClamp_0_max_f(energy, maxEnergy);
    
    if (sun)
    {
        UPDATE_STAGE(@"updating sun effects");
        
        // set the ambient temperature here
        double  sun_zd = sun->zero_distance;    // square of distance
        double  sun_cr = sun->collision_radius;
        double  alt1 = sun_cr * sun_cr / sun_zd;
        external_temp = SUN_TEMPERATURE * alt1;
 
        if ([sun goneNova])
            external_temp *= 100;
        // fuel scooping during the nova mission very unlikely
        if ([sun willGoNova])
            external_temp *= 3;
            
        // do Revised sun-skimming check here...
        if ([self hasFuelScoop] && alt1 > 0.75 && [self fuel] < [self fuelCapacity])
        {
            fuel_accumulator += (float)(delta_t * flightSpeed * 0.010 / [self fuelChargeRate]);
            // are we fast enough to collect any fuel?
            scoopsActive = YES && flightSpeed > 0.1f;
            while (fuel_accumulator > 1.0f)
            {
                [self setFuel:[self fuel] + 1];
                fuel_accumulator -= 1.0f;
                [self doScriptEvent:OOJSID("shipScoopedFuel")];
            }
            [UNIVERSE displayCountdownMessage:DESC(@"fuel-scoop-active") forCount:1.0];
        }
    }
    
    //Bug #11692 CmdrJames added Status entering witchspace
    OOEntityStatus status = [self status];
    if ((status != STATUS_ESCAPE_SEQUENCE) && (status != STATUS_ENTERING_WITCHSPACE))
    {
        UPDATE_STAGE(@"updating cabin temperature");
        
        // work on the cabin temperature
        float heatInsulation = [self heatInsulation]; // Optimisation, suggested by EricW
        float deltaInsulation = delta_t/heatInsulation;
        float heatThreshold = heatInsulation * 100.0f;
        ship_temperature += (float)( flightSpeed * air_friction * deltaInsulation); // wind_speed
        
        if (external_temp > heatThreshold && external_temp > ship_temperature)
            ship_temperature += (float)((external_temp - ship_temperature) * SHIP_INSULATION_FACTOR  * deltaInsulation);
        else
        {
            if (ship_temperature > SHIP_MIN_CABIN_TEMP)
                ship_temperature += (float)((external_temp - heatThreshold - ship_temperature) * SHIP_COOLING_FACTOR  * deltaInsulation);
        }
        
        if (ship_temperature > SHIP_MAX_CABIN_TEMP)
            [self takeHeatDamage: delta_t * ship_temperature];
    }
    
    if ((status == STATUS_ESCAPE_SEQUENCE)&&(shot_time > ESCAPE_SEQUENCE_TIME))
    {
        UPDATE_STAGE(@"resetting after escape");
        ShipEntity  *doppelganger = (ShipEntity*)[self foundTarget];
        // reset legal status again! Could have changed if a previously launched missile hit a clean NPC while in the escape pod.
        [self setBounty:0 withReason:kOOLegalStatusReasonEscapePod];
        bounty = 0;
        thrust = max_thrust; // re-enable inertialess drives
        // no access to all player.ship properties while inside the escape pod,
        // we're not supposed to be inside our ship anymore! 
        [self doScriptEvent:OOJSID("escapePodSequenceOver")];   // allow oxps to override the escape pod target
        if (EXPECT_NOT(target_system_id != system_id)) // overridden: we're going to a nearby system!
        {
            system_id = target_system_id;
            info_system_id = target_system_id;
            [UNIVERSE setSystemTo:system_id];
            galaxy_coordinates = PointFromString([[UNIVERSE systemManager] getProperty:@"coordinates" forSystem:system_id inGalaxy:galaxy_number]);
            
            [UNIVERSE setUpSpace];
            // run initial system population
            [UNIVERSE populateNormalSpace];
 
            [self setDockTarget:[UNIVERSE station]];
            // send world script events to let oxps know we're in a new system.
            // all player.ship properties are still disabled at this stage.
            [UNIVERSE setWitchspaceBreakPattern:YES];
            [self doScriptEvent:OOJSID("shipWillExitWitchspace")];
            [self doScriptEvent:OOJSID("shipExitedWitchspace")];
            
            [[UNIVERSE planet] update: 2.34375 * market_rnd];   // from 0..10 minutes
            [[UNIVERSE station] update: 2.34375 * market_rnd];  // from 0..10 minutes
        }
        
        Entity  *dockTargetEntity = [UNIVERSE entityForUniversalID:_dockTarget];    // main station in the original system, unless overridden.
        if ([dockTargetEntity isStation]) // fails if _dockTarget is NO_TARGET
        {
            [doppelganger becomeExplosion]; // blow up the doppelganger
            // restore player ship
            ShipEntity *player_ship = [UNIVERSE newShipWithName:[self shipDataKey]];    // retained
            if (player_ship)
            {
                // FIXME: this should use OOShipType, which should exist. -- Ahruman
                [self setMesh:[player_ship mesh]];
                [player_ship release];                      // we only wanted it for its polygons!
            }
            [UNIVERSE setViewDirection:VIEW_FORWARD];
            [UNIVERSE setBlockJSPlayerShipProps:NO];    // re-enable player.ship!
            [self enterDock:(StationEntity *)dockTargetEntity];
        }
        else    // no dock target? dock target is not a station? game over!
        {
            [self setStatus:STATUS_DEAD];
            //[self playGameOver];  // no death explosion sounds for player pods
            // no shipDied events for player pods, either
            [UNIVERSE displayMessage:DESC(@"gameoverscreen-escape-pod") forCount:kDeadResetTime];
            [UNIVERSE displayMessage:@"" forCount:kDeadResetTime];
            [self showGameOver];
        }
    }
    
    
    // MOVED THE FOLLOWING FROM PLAYERENTITY POLLFLIGHTCONTROLS:
    travelling_at_hyperspeed = (flightSpeed > maxFlightSpeed);
    if (hyperspeed_engaged)
    {
        UPDATE_STAGE(@"updating hyperspeed");
        
        // increase speed up to maximum hyperspeed
        if (flightSpeed < maxFlightSpeed * HYPERSPEED_FACTOR)
            flightSpeed += (float)(speed_delta * delta_t * HYPERSPEED_FACTOR);
        if (flightSpeed > maxFlightSpeed * HYPERSPEED_FACTOR)
            flightSpeed = (float)(maxFlightSpeed * HYPERSPEED_FACTOR);
        
        // check for mass lock
        hyperspeed_locked = [self massLocked];
        // check for mass lock & external temperature?
        //hyperspeed_locked = flightSpeed * air_friction > 40.0f+(ship_temperature - external_temp ) * SHIP_COOLING_FACTOR || [self massLocked];
        
        if (hyperspeed_locked)
        {
            [self playJumpMassLocked];
            [UNIVERSE addMessage:DESC(@"jump-mass-locked") forCount:4.5];
            hyperspeed_engaged = NO;
        }
    }
    else
    {
        if (afterburner_engaged)
        {
            UPDATE_STAGE(@"updating afterburner");
            
            float abFactor = [self afterburnerFactor];
            float maxInjectionSpeed = maxFlightSpeed * abFactor;
            if (flightSpeed > maxInjectionSpeed)
            {
                // decellerate to maxInjectionSpeed but slower than without afterburner.
                flightSpeed -= (float)(speed_delta * delta_t * abFactor);
            }
            else
            {
                if (flightSpeed < maxInjectionSpeed)
                    flightSpeed += (float)(speed_delta * delta_t * abFactor);
                if (flightSpeed > maxInjectionSpeed)
                    flightSpeed = maxInjectionSpeed;
            }
            fuel_accumulator -= (float)(delta_t * afterburner_rate);
            while ((fuel_accumulator < 0)&&(fuel > 0))
            {
                fuel_accumulator += 1.0f;
                if (--fuel <= MIN_FUEL)
                    afterburner_engaged = NO;
            }
        }
        else
        {
            UPDATE_STAGE(@"slowing from hyperspeed");
            
            // slow back down...
            if (travelling_at_hyperspeed)
            {
                // decrease speed to maximum normal speed
                float deceleration = (speed_delta * delta_t * HYPERSPEED_FACTOR);
                if (alertFlags & ALERT_FLAG_MASS_LOCK)
                {
                    // decelerate much quicker in masslocks
                    // this does also apply to injector deceleration
                    // but it's not very noticeable
                    deceleration *= 3;
                }
                flightSpeed -= deceleration;
                if (flightSpeed < maxFlightSpeed)
                    flightSpeed = maxFlightSpeed;
            }
        }
    }
    
    
    
    // fuel leakage
    if ((fuel_leak_rate > 0.0)&&(fuel > 0))
    {
        UPDATE_STAGE(@"updating fuel leakage");
        
        fuel_accumulator -= (float)(fuel_leak_rate * delta_t);
        while ((fuel_accumulator < 0)&&(fuel > 0))
        {
            fuel_accumulator += 1.0f;
            fuel--;
        }
        if (fuel == 0)
            fuel_leak_rate = 0;
    }
    
    // smart_zoom
    UPDATE_STAGE(@"updating scanner zoom");
    if (scanner_zoom_rate)
    {
        double z = [hud scannerZoom];
        double z1 = z + scanner_zoom_rate * delta_t;
        if (scanner_zoom_rate > 0.0)
        {
            if (floor(z1) > floor(z))
            {
                z1 = floor(z1);
                scanner_zoom_rate = 0.0f;
            }
        }
        else
        {
            if (z1 < 1.0)
            {
                z1 = 1.0;
                scanner_zoom_rate = 0.0f;
            }
        }
        [hud setScannerZoom:z1];
    }
 
    [[UNIVERSE gameView] setFov:fieldOfView fromFraction:YES];
    
    // scanner sanity check - lose any targets further than maximum scanner range
    ShipEntity *primeTarget = [self primaryTarget];
    if (primeTarget && HPdistance2([primeTarget position], [self position]) > SCANNER_MAX_RANGE2 && !autopilot_engaged)
    {
        [UNIVERSE addMessage:DESC(@"target-lost") forCount:3.0];
        [self removeTarget:primeTarget];
    }
    // compass sanity check and update target for changed mode
    [self validateCompassTarget];
    
    // update subentities
    UPDATE_STAGE(@"updating subentities");
    totalBoundingBox = boundingBox; //  reset totalBoundingBox
    ShipEntity *se = nil;
    foreach (se, [self subEntities])
    {
        [se update:delta_t];
        if ([se isShip])
        {
            BoundingBox sebb = [se findSubentityBoundingBox];
            bounding_box_add_vector(&totalBoundingBox, sebb.max);
            bounding_box_add_vector(&totalBoundingBox, sebb.min);
        }
    }
    // and one thing which isn't a subentity. Fixes bug with
    // mispositioned laser beams particularly noticeable on side view.
    if (lastShot != nil)
    {
        OOLaserShotEntity *lse = nil;
        foreach (lse, lastShot)
        {
            [lse update:0.0];
        }
        DESTROY(lastShot);
    }
    
    // update mousewheel status
    UPDATE_STAGE(@"updating mousewheel delta");
    MyOpenGLView *gView = [UNIVERSE gameView];
    float mouseWheelDelta = [gView mouseWheelDelta];
    if (mouseWheelDelta > 0.0f)
    {
        if (mouseWheelDelta < delta_t)  [gView setMouseWheelDelta:0.0f];
        else  [gView setMouseWheelDelta:mouseWheelDelta - delta_t];
    }
    else if (mouseWheelDelta < 0.0f)
    {
        if (mouseWheelDelta > -delta_t)  [gView setMouseWheelDelta:0.0f];
        else  [gView setMouseWheelDelta:mouseWheelDelta + delta_t];
    }
    
    STAGE_TRACKING_END
}

docked

- (void) docked

Definition at line 13727 of file PlayerEntity.m.

{
    StationEntity *dockedStation = [self dockedStation];
    if (dockedStation == nil)
    {
        [self setStatus:STATUS_IN_FLIGHT];
        return;
    }
    
    [self setStatus:STATUS_DOCKED];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO];
    
    [self loseTargetStatus];
    
    [self setPosition:[dockedStation position]];
    [self setOrientation:kIdentityQuaternion];  // reset orientation to dock
    
    flightRoll = 0.0f;
    flightPitch = 0.0f;
    flightYaw = 0.0f;
    flightSpeed = 0.0f;
    
    hyperspeed_engaged = NO;
    hyperspeed_locked = NO;
    
    forward_shield =    [self maxForwardShieldLevel];
    aft_shield =        [self maxAftShieldLevel];
    energy =            maxEnergy;
    weapon_temp =       0.0f;
    ship_temperature =  60.0f;
 
    [self setAlertFlag:ALERT_FLAG_DOCKED to:YES];
 
    if ([dockedStation localMarket] == nil)
    {
        [dockedStation initialiseLocalMarket];
    }
 
    NSString *escapepodReport = [self processEscapePods];
    [self addMessageToReport:escapepodReport];
    
    [self unloadCargoPods]; // fill up the on-ship commodities before...
 
    // check import status of station
    // escape pods must be cleared before this happens
    if ([dockedStation marketMonitored])
    {
        OOCreditsQuantity oldbounty = [self bounty];
        [self markAsOffender:[dockedStation legalStatusOfManifest:shipCommodityData export:NO] withReason:kOOLegalStatusReasonIllegalImports];
        if ([self bounty] > oldbounty)
        {
            [self addRoleToPlayer:@"trader-smuggler"];
        }
    }
 
    // check contracts
    NSString *passengerAndCargoReport = [self checkPassengerContracts]; // Is also processing cargo and parcel contracts.
    [self addMessageToReport:passengerAndCargoReport];
        
    [UNIVERSE setDisplayText:YES];
    
    [[OOMusicController sharedController] stopDockingMusic];
    [[OOMusicController sharedController] playDockedMusic];
    
    // Did we fail to observe traffic control regulations? However, due to the state of emergency,
    // apply no unauthorized docking penalties if a nova is ongoing.
    if ([dockedStation requiresDockingClearance] &&
            ![self clearedToDock] && ![[UNIVERSE sun] willGoNova])
    {
        [self penaltyForUnauthorizedDocking];
    }
        
    // apply any pending fines. (No need to check gui_screen as fines is no longer an on-screen message).
    if (dockedStation == [UNIVERSE station])
    {
        // TODO: A proper system to allow some OXP stations to have a
        // galcop presence for fines. - CIM 18/11/2012
        if (being_fined && ![[UNIVERSE sun] willGoNova] && ![dockedStation suppressArrivalReports]) [self getFined];
    }
 
    // it's time to check the script - can trigger legacy missions
    if (gui_screen != GUI_SCREEN_MISSION)  [self checkScript]; // a scripted pilot could have created a mission screen.
    
    OOJSStartTimeLimiterWithTimeLimit(kOOJSLongTimeLimit);
    [self doScriptEvent:OOJSID("shipDockedWithStation") withArgument:dockedStation];
    OOJSStopTimeLimiter();
    if ([self status] == STATUS_LAUNCHING) return;
 
    // if we've not switched to the mission screen yet then proceed normally..
    if (gui_screen != GUI_SCREEN_MISSION)
    {
        [self setGuiToStatusScreen];
    }
    [[OOCacheManager sharedCache] flush];
    [[OOJavaScriptEngine sharedEngine] garbageCollectionOpportunity:YES];
    
    // When a mission screen is started, any on-screen message is removed immediately.
    [self doWorldEventUntilMissionScreen:OOJSID("missionScreenOpportunity")];   // also displays docking reports first.
}

dockedAtMainStation

- (BOOL) dockedAtMainStation

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return [self status] == STATUS_DOCKED && [self dockedStation] == [UNIVERSE station];
}

dockedAtMainStation_bool

- (NSString *) dockedAtMainStation_bool

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    if ([self dockedAtMainStation])  return @"YES";
    else  return @"NO";
}

dockedStation

- (StationEntity *) dockedStation

Definition at line 13727 of file PlayerEntity.m.

{
    return [_dockedStation weakRefUnderlyingObject];
}

Referenced by PlayerShipGetProperty().

Here is the caller graph for this function:

dockedStationDisplayName

- (NSString *) dockedStationDisplayName

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return [[self dockedStation] displayName];
}

dockedStationName

- (NSString *) dockedStationName

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return [[self dockedStation] name];
}

dockedStationName_string

- (NSString *) dockedStationName_string

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    NSString            *result = nil;
    if ([self status] != STATUS_DOCKED)  return @"NONE";
    
    result = [self dockedStationName];
    if (result == nil)  result = @"UNKNOWN";
    return result;
}

dockedTechLevel_number

- (NSNumber *) dockedTechLevel_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    StationEntity *dockedStation = [self dockedStation];
    if (!dockedStation) 
    {
        return [self systemTechLevel_number];
    }
    return [NSNumber numberWithUnsignedInteger:[dockedStation equivalentTechLevel]];
}

doesHitLine:v0:v1:

- (GLfloat) doesHitLine: (HPVector)  v0: (HPVector)  v1: (ShipEntity **)  hitEntity

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                       :(HPVector)v0 :(HPVector)v1 :(ShipEntity **)hitEntity
{
    if (hitEntity)
        hitEntity[0] = (ShipEntity*)nil;
    Vector u0 = HPVectorToVector(HPvector_between(position, v0));   // relative to origin of model / octree
    Vector u1 = HPVectorToVector(HPvector_between(position, v1));
    Vector w0 = make_vector(dot_product(u0, v_right), dot_product(u0, v_up), dot_product(u0, v_forward));   // in ijk vectors
    Vector w1 = make_vector(dot_product(u1, v_right), dot_product(u1, v_up), dot_product(u1, v_forward));
    GLfloat hit_distance = [octree isHitByLine:w0 :w1];
    if (hit_distance)
    {
        if (hitEntity)
            hitEntity[0] = self;
    }
 
    bool shields = false;
    if ((w0.z >= 0 && forward_shield > 1) || (w0.z <= 0 && aft_shield > 1))
    {
        shields = true;
    }
    
    NSEnumerator    *subEnum = nil;
    ShipEntity      *se = nil;
    for (subEnum = [self shipSubEntityEnumerator]; (se = [subEnum nextObject]); )
    {
        HPVector p0 = [se absolutePositionForSubentity];
        Triangle ijk = [se absoluteIJKForSubentity];
        u0 = HPVectorToVector(HPvector_between(p0, v0));
        u1 = HPVectorToVector(HPvector_between(p0, v1));
        w0 = resolveVectorInIJK(u0, ijk);
        w1 = resolveVectorInIJK(u1, ijk);
        
        GLfloat hitSub = [se->octree isHitByLine:w0 :w1];
        if (hitSub && (hit_distance == 0 || hit_distance > hitSub))
        {   
            hit_distance = hitSub;
            if (hitEntity && !shields)
            {
                *hitEntity = se;
            }
        }
    }
    
    return hit_distance;
}

doGuiScreenResizeUpdates

- (void) doGuiScreenResizeUpdates

Definition at line 13727 of file PlayerEntity.m.

{
    switch ([self guiScreen])
    {
        case GUI_SCREEN_GAMEOPTIONS:
            //refresh play windowed / full screen
            [self setGuiToGameOptionsScreen];
            break;
        case GUI_SCREEN_STATUS:
            // status screen must be redone in order to possibly
            // refresh displayed model's draw position
            [self setGuiToStatusScreen];
            break;
        default:
            break;
    }
 
 
    [hud resetGuiPositions];
}

doMissionCallback

- (void) doMissionCallback

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    // make sure we don't call the same callback twice
    _missionWithCallback = NO;
    [[OOJavaScriptEngine sharedEngine] runMissionCallback];
}

doScriptEvent:inContext:withArguments:count:

- (void) doScriptEvent: (jsid)  message inContext: (JSContext *)  context withArguments: (jsval *)  argv count: (uintN)  argc

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                      :(jsid)message inContext:(JSContext *)context withArguments:(jsval *)argv count:(uintN)argc
{
    [super doScriptEvent:message inContext:context withArguments:argv count:argc];
    [self doWorldScriptEvent:message inContext:context withArguments:argv count:argc timeLimit:0.0];
}

doTradeIn:forPriceFactor:

- (void) doTradeIn: (OOCreditsQuantity)  tradeInValue forPriceFactor: (double)  priceFactor

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 9242 of file PlayerEntity.m.

                  :(OOCreditsQuantity)tradeInValue forPriceFactor:(double)priceFactor
{
    if (tradeInValue != 0)
    {
        if (priceFactor < 1.0)  tradeInValue *= priceFactor;
        credits += tradeInValue;
    }
}

doWorldEventUntilMissionScreen:

- (BOOL) doWorldEventUntilMissionScreen:

(jsid)

message

Definition at line 9242 of file PlayerEntity.m.

                                       :(jsid)message
{
    NSEnumerator    *scriptEnum = [worldScripts objectEnumerator];
    OOScript        *theScript;
 
    // Check for the presence of report messages first.
    if (gui_screen != GUI_SCREEN_MISSION && [dockingReport length] > 0 && [self isDocked] && ![[self dockedStation] suppressArrivalReports])
    {
        [self setGuiToDockingReportScreen]; // go here instead!
        [[UNIVERSE messageGUI] clear];
        return YES;
    }
    
    JSContext *context = OOJSAcquireContext();
    while ((theScript = [scriptEnum nextObject]) && gui_screen != GUI_SCREEN_MISSION && [self isDocked])
    {
        [theScript callMethod:message inContext:context withArguments:NULL count:0 result:NULL];
    }
    OOJSRelinquishContext(context);
    
    if (gui_screen == GUI_SCREEN_MISSION)
    {
        // remove any comms/console messages from the screen!
        [[UNIVERSE messageGUI] clear];
        return YES;
    }
    
    return NO;
}

doWorldScriptEvent:inContext:withArguments:count:timeLimit:

- (void) doWorldScriptEvent:		(jsid)	message
inContext:		(JSContext *)	context
withArguments:		(jsval *)	argv
count:		(uintN)	argc
timeLimit:		(OOTimeDelta)	limit

Definition at line 9242 of file PlayerEntity.m.

                           :(jsid)message inContext:(JSContext *)context withArguments:(jsval *)argv count:(uintN)argc timeLimit:(OOTimeDelta)limit
{
    NSParameterAssert(context != NULL && JS_IsInRequest(context));
    
    OOScript                *theScript = nil;
    
    foreach (theScript, [worldScripts allValues])
    {
        OOJSStartTimeLimiterWithTimeLimit(limit);
        [theScript callMethod:message inContext:context withArguments:argv count:argc result:NULL];
        OOJSStopTimeLimiter();
    }
}

drawImmediate:translucent:

- (void) drawImmediate: (bool)  immediate translucent: (bool)  translucent

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                      :(bool)immediate translucent:(bool)translucent
{
    switch ([self status])
    {
        case STATUS_DEAD:
        case STATUS_COCKPIT_DISPLAY:
        case STATUS_DOCKED:
        case STATUS_START_GAME:
            return;
            
        default:
            if ([UNIVERSE breakPatternHide])  return;
    }
    
    [super drawImmediate:immediate translucent:translucent];
}

drawRotationMatrix

- (OOMatrix) drawRotationMatrix

implementation

Reimplemented from Entity.

Definition at line 13727 of file PlayerEntity.m.

{
    return playerRotMatrix;
}

drawTransformationMatrix

- (OOMatrix) drawTransformationMatrix

implementation

Reimplemented from Entity.

Definition at line 13727 of file PlayerEntity.m.

{
    OOMatrix result = playerRotMatrix;
    // HPVect: modify to use camera-relative positioning
    return OOMatrixTranslate(result, HPVectorToVector(position));
}

dumpCargo

- (OOCommodityType) dumpCargo

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    if (flightSpeed > 4.0 * maxFlightSpeed)
    {
        [UNIVERSE addMessage:OOExpandKey(@"hold-locked") forCount:3.0];
        return nil;
    }
 
    OOCommodityType result = [super dumpCargo];
    if (result != nil)
    {
        NSString *commodity = [UNIVERSE displayNameForCommodity:result];
        [UNIVERSE addMessage:OOExpandKey(@"commodity-ejected", commodity) forCount:3.0 forceDisplay:YES];
        [self playCargoJettisioned];
    }
    return result;
}

dumpSelfState

- (void) dumpSelfState

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

{
    NSMutableArray      *flags = nil;
    NSString            *flagsString = nil;
    
    [super dumpSelfState];
    
    OOLog(@"dumpState.playerEntity", @"Script time: %g", script_time);
    OOLog(@"dumpState.playerEntity", @"Script time check: %g", script_time_check);
    OOLog(@"dumpState.playerEntity", @"Script time interval: %g", script_time_interval);
    OOLog(@"dumpState.playerEntity", @"Roll/pitch/yaw delta: %g, %g, %g", roll_delta, pitch_delta, yaw_delta);
    OOLog(@"dumpState.playerEntity", @"Shield: %g fore, %g aft", forward_shield, aft_shield);
    OOLog(@"dumpState.playerEntity", @"Alert level: %u, flags: %#x", alertFlags, alertCondition);
    OOLog(@"dumpState.playerEntity", @"Missile status: %i", missile_status);
    OOLog(@"dumpState.playerEntity", @"Energy unit: %@", EnergyUnitTypeToString([self installedEnergyUnitType]));
    OOLog(@"dumpState.playerEntity", @"Fuel leak rate: %g", fuel_leak_rate);
    OOLog(@"dumpState.playerEntity", @"Trumble count: %llu", trumbleCount);
    
    flags = [NSMutableArray array];
    #define ADD_FLAG_IF_SET(x)      if (x) { [flags addObject:@#x]; }
    ADD_FLAG_IF_SET(found_equipment);
    ADD_FLAG_IF_SET(pollControls);
    ADD_FLAG_IF_SET(suppressTargetLost);
    ADD_FLAG_IF_SET(scoopsActive);
    ADD_FLAG_IF_SET(game_over);
    ADD_FLAG_IF_SET(finished);
    ADD_FLAG_IF_SET(bomb_detonated);
    ADD_FLAG_IF_SET(autopilot_engaged);
    ADD_FLAG_IF_SET(afterburner_engaged);
    ADD_FLAG_IF_SET(afterburnerSoundLooping);
    ADD_FLAG_IF_SET(hyperspeed_engaged);
    ADD_FLAG_IF_SET(travelling_at_hyperspeed);
    ADD_FLAG_IF_SET(hyperspeed_locked);
    ADD_FLAG_IF_SET(ident_engaged);
    ADD_FLAG_IF_SET(galactic_witchjump);
    ADD_FLAG_IF_SET(ecm_in_operation);
    ADD_FLAG_IF_SET(show_info_flag);
    ADD_FLAG_IF_SET(showDemoShips);
    ADD_FLAG_IF_SET(rolling);
    ADD_FLAG_IF_SET(pitching);
    ADD_FLAG_IF_SET(yawing);
    ADD_FLAG_IF_SET(using_mining_laser);
    ADD_FLAG_IF_SET(mouse_control_on);
//  ADD_FLAG_IF_SET(isSpeechOn);
    ADD_FLAG_IF_SET(keyboardRollOverride);   // Handle keyboard roll...
    ADD_FLAG_IF_SET(keyboardPitchOverride);  // ...and pitch override separately - (fix for BUG #17490)
    ADD_FLAG_IF_SET(keyboardYawOverride);
    ADD_FLAG_IF_SET(waitingForStickCallback);
    flagsString = [flags count] ? [flags componentsJoinedByString:@", "] : (NSString *)@"none";
    OOLog(@"dumpState.playerEntity", @"Flags: %@", flagsString);
}

ejectItem:

- (void) ejectItem:

(NSString *)

item_key

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *)itemKey
{
    if (scriptTarget == nil)  scriptTarget = self;
    [scriptTarget ejectShipOfType:itemKey];
}

endMissionScreenAndNoteOpportunity

- (void) endMissionScreenAndNoteOpportunity

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    _missionAllowInterrupt = NO;
    [self clearMissionScreenID];
    // Older scripts might intercept missionScreenEnded first, and call secondary mission screens.
    if(![self doWorldEventUntilMissionScreen:OOJSID("missionScreenEnded")])
    {
        // if we're here, no mission screen is running. Opportunity! :)
        [self doWorldEventUntilMissionScreen:OOJSID("missionScreenOpportunity")];
    }
}

endScenario:

- (BOOL) endScenario:

(NSString *)

key

Definition at line 13727 of file PlayerEntity.m.

                    :(NSString *)key
{
    if (scenarioKey != nil && [key isEqualToString:scenarioKey])
    {
        [self setStatus:STATUS_RESTART_GAME];
        return YES;
    }
    return NO;
}

energyUnitType

- (OOEnergyUnitType) energyUnitType

Definition at line 13727 of file PlayerEntity.m.

{
    if ([self hasEquipmentItem:@"EQ_NAVAL_ENERGY_UNIT"])  return ENERGY_UNIT_NAVAL;
    if ([self hasEquipmentItem:@"EQ_ENERGY_UNIT"])  return ENERGY_UNIT_NORMAL;
    if ([self hasEquipmentItem:@"EQ_NAVAL_ENERGY_UNIT_DAMAGED"])  return ENERGY_UNIT_NAVAL_DAMAGED;
    if ([self hasEquipmentItem:@"EQ_ENERGY_UNIT_DAMAGED"])  return ENERGY_UNIT_NORMAL_DAMAGED;
    return ENERGY_UNIT_NONE;
}

engageAutopilotToStation:

- (BOOL) engageAutopilotToStation:

(StationEntity *)

stationForDocking

Definition at line 13727 of file PlayerEntity.m.

                                 :(StationEntity *)stationForDocking
{
    if (stationForDocking == nil)   return NO;
    if ([self isDocked])  return NO;
    
    if (autopilot_engaged && [self targetStation] == stationForDocking)
    {   
        return YES;
    }
        
    [self setTargetStation:stationForDocking];
    DESTROY(_primaryTarget);
    autopilot_engaged = YES;
    ident_engaged = NO;
    [self safeAllMissiles];
    velocity = kZeroVector;
    if ([self status] == STATUS_WITCHSPACE_COUNTDOWN) [self cancelWitchspaceCountdown]; // cancel witchspace countdown properly
    [self setStatus:STATUS_AUTOPILOT_ENGAGED];
    [self resetAutopilotAI];
    [shipAI setState:@"BEGIN_DOCKING"]; // reboot the AI
    [self playAutopilotOn];
    [[OOMusicController sharedController] playDockingMusic];
    [self doScriptEvent:OOJSID("playerStartedAutoPilot") withArgument:stationForDocking];
    [self setDockingClearanceStatus:DOCKING_CLEARANCE_STATUS_GRANTED];
        
    if (afterburner_engaged)
    {
        afterburner_engaged = NO;
        if (afterburnerSoundLooping)  [self stopAfterburnerSound];
    }
    return YES;
}

enterDock:

- (void) enterDock: (StationEntity *)  station

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                  :(StationEntity *)station
{
    NSParameterAssert(station != nil);
    if ([self status] == STATUS_DEAD)  return;
    
    [self setStatus:STATUS_DOCKING];
    [self setDockedStation:station];
    [self doScriptEvent:OOJSID("shipWillDockWithStation") withArgument:station];
 
    if (![hud nonlinearScanner])
    {
        [hud setScannerZoom: 1.0];
    }
    ident_engaged = NO;
    afterburner_engaged = NO;
    autopilot_engaged = NO;
    [self resetAutopilotAI];
    
    cloaking_device_active = NO;
    hyperspeed_engaged = NO;
    hyperspeed_locked = NO;
    [self safeAllMissiles];
    DESTROY(_primaryTarget); // must happen before showing break_pattern to suppress active reticule.
    [self clearTargetMemory];
    
    scanner_zoom_rate = 0.0f;
    [UNIVERSE setDisplayText:NO];
    [[UNIVERSE gameController] setMouseInteractionModeForFlight];
    if ([self status] == STATUS_LAUNCHING)  return; // a JS script has aborted the docking.
    
    [self setOrientation: kIdentityQuaternion]; // reset orientation to dock
    [UNIVERSE setUpBreakPattern:[self breakPatternPosition] orientation:orientation forDocking:YES];
    [self playDockWithStation];
    [station noteDockedShip:self];
    
    [[UNIVERSE gameView] clearKeys];    // try to stop key bounces
}

Referenced by StationDockPlayer().

Here is the caller graph for this function:

enterGalacticWitchspace

- (void) enterGalacticWitchspace

Definition at line 13727 of file PlayerEntity.m.

{
    if (![self witchJumpChecklist:true])
        return;
 
 
    OOGalaxyID destGalaxy = galaxy_number + 1;
    if (EXPECT_NOT(destGalaxy >= OO_GALAXIES_AVAILABLE))
    {
        destGalaxy = 0;
    }
 
 
    [self setStatus:STATUS_ENTERING_WITCHSPACE];
    JSContext *context = OOJSAcquireContext();
    [self setJumpCause:@"galactic jump"];
    [self setPreviousSystemID:[self currentSystemID]];
    ShipScriptEvent(context, self, "shipWillEnterWitchspace", STRING_TO_JSVAL(JS_InternString(context, [[self jumpCause] UTF8String])), INT_TO_JSVAL(destGalaxy));
    OOJSRelinquishContext(context);
 
    [self noteCompassLostTarget];
 
    [self witchStart];
    
    [UNIVERSE removeAllEntitiesExceptPlayer];
    
    // remove any contracts and parcels for the old galaxy
    if (contracts)
        [contracts removeAllObjects];
 
    if (parcels)
        [parcels removeAllObjects];
    
    // remove any mission destinations for the old galaxy
    if (missionDestinations)
        [missionDestinations removeAllObjects];
    
    // expire passenger contracts for the old galaxy
    if (passengers)
    {
        unsigned i;
        for (i = 0; i < [passengers count]; i++)
        {
            // set the expected arrival time to now, so they storm off the ship at the first port
            NSMutableDictionary* passenger_info = [NSMutableDictionary dictionaryWithDictionary:[passengers oo_dictionaryAtIndex:i]];
            [passenger_info setObject:[NSNumber numberWithDouble:ship_clock] forKey:CONTRACT_KEY_ARRIVAL_TIME];
            [passengers replaceObjectAtIndex:i withObject:passenger_info];
        }
    }
 
    // clear a lot of memory of player actions
    if (ship_kills >= 6400)
    {
        [self clearRolesFromPlayer:0.25];
    }
    else if (ship_kills >= 2560)
    {
        [self clearRolesFromPlayer:0.5];
    }
    else
    {
        [self clearRolesFromPlayer:0.9];
    }   
    [roleWeightFlags removeAllObjects];
    [roleSystemList removeAllObjects];
    
    // may be more than one item providing this
    [self removeEquipmentItem:[self equipmentItemProviding:@"EQ_GAL_DRIVE"]];
    
    galaxy_number = destGalaxy;
 
    [UNIVERSE setGalaxyTo:galaxy_number];
 
    // Choose the galactic hyperspace behaviour. Refers to where we may actually end up after an intergalactic jump.
    // The default behaviour is that the player cannot arrive on unreachable or isolated systems. The options
    // in planetinfo.plist, galactic_hyperspace_behaviour key can be used to allow arrival even at unreachable systems,
    // or at fixed coordinates on the galactic chart. The key galactic_hyperspace_fixed_coords in planetinfo.plist is
    // used in the fixed coordinates case and specifies the exact coordinates for the intergalactic jump.
    switch (galacticHyperspaceBehaviour)
    {
        case GALACTIC_HYPERSPACE_BEHAVIOUR_FIXED_COORDINATES:           
            system_id = [UNIVERSE findSystemNumberAtCoords:galacticHyperspaceFixedCoords withGalaxy:galaxy_number includingHidden:YES];
            break;
        case GALACTIC_HYPERSPACE_BEHAVIOUR_ALL_SYSTEMS_REACHABLE:
            system_id = [UNIVERSE findSystemNumberAtCoords:galaxy_coordinates withGalaxy:galaxy_number includingHidden:YES];
            break;
        case GALACTIC_HYPERSPACE_BEHAVIOUR_STANDARD:
        default:
            // instead find a system connected to system 0 near the current coordinates...
            system_id = [UNIVERSE findConnectedSystemAtCoords:galaxy_coordinates withGalaxy:galaxy_number];
            break;
    }
    target_system_id = system_id;
    info_system_id = system_id;
    
    [self setBounty:0 withReason:kOOLegalStatusReasonNewGalaxy];    // let's make a fresh start!
    cursor_coordinates = PointFromString([[UNIVERSE systemManager] getProperty:@"coordinates" forSystem:system_id inGalaxy:galaxy_number]);
 
    [self witchEnd]; // sets coordinates, calls exiting witchspace JS events
}

enterWitchspace

- (void) enterWitchspace

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    if (![self witchJumpChecklist:false])  return;
    
    OOSystemID jumpTarget = [self nextHopTargetSystemID];
 
    //  perform any check here for forced witchspace encounters
    unsigned malfunc_chance = 253;
    if (ship_trade_in_factor < 80)
    {
        malfunc_chance -= (1 + ranrot_rand() % (81-ship_trade_in_factor)) / 2;  // increase chance of misjump in worn-out craft
    }
    else if (ship_trade_in_factor >= 100)
    {
        malfunc_chance = 256; // force no misjumps on first jump
    }
 
#ifdef OO_DUMP_PLANETINFO
    BOOL misjump = NO; // debugging
#else
    BOOL malfunc = ((ranrot_rand() & 0xff) > malfunc_chance);
    // 75% of the time a malfunction means a misjump
    BOOL misjump = [self scriptedMisjump] || (flightPitch == max_flight_pitch) || (malfunc && (randf() > 0.75));
 
    if (malfunc && !misjump)
    {
        // some malfunctions will start fuel leaks, some will result in no witchjump at all.
        if ([self takeInternalDamage])  // Depending on ship type and loaded cargo, this will be true for 20 - 50% of the time.
        {
            [self playWitchjumpFailure];
            [self setStatus:STATUS_IN_FLIGHT];
            ShipScriptEventNoCx(self, "playerJumpFailed", OOJSSTR("malfunction"));
            return;
        }
        else
        {
            [self setFuelLeak:[NSString stringWithFormat:@"%f", (randf() + randf()) * 5.0]];
        }
    }
#endif  
 
    // From this point forward we are -definitely- witchjumping
    
    // burn the full fuel amount to create the wormhole
    fuel -= [self fuelRequiredForJump];
    
    // Create the players' wormhole
    wormhole = [[WormholeEntity alloc] initWormholeTo:jumpTarget fromShip:self];
    [UNIVERSE addEntity:wormhole]; // Add new wormhole to Universe to let other ships target it. Required for ships following the player.
    [self addScannedWormhole:wormhole];
    
    [self setStatus:STATUS_ENTERING_WITCHSPACE];
    JSContext *context = OOJSAcquireContext();
    [self setJumpCause:@"standard jump"];
    [self setPreviousSystemID:[self currentSystemID]];
    ShipScriptEvent(context, self, "shipWillEnterWitchspace", STRING_TO_JSVAL(JS_InternString(context, [[self jumpCause] UTF8String])), INT_TO_JSVAL(jumpTarget));
    OOJSRelinquishContext(context);
 
    [self updateSystemMemory];
    NSUInteger legality = [self legalStatusOfCargoList];
    OOCargoQuantity maxSpace = [self maxAvailableCargoSpace];
    OOCargoQuantity availSpace = [self availableCargoSpace];
    if ([roleWeightFlags objectForKey:@"bought-legal"])
    {
        if (maxSpace != availSpace)
        {
            [self addRoleToPlayer:@"trader"];
            if (maxSpace - availSpace > 20 || availSpace == 0)
            {
                if (legality == 0)
                {
                    [self addRoleToPlayer:@"trader"];
                }
            }
        }
    }
    if ([roleWeightFlags objectForKey:@"bought-illegal"])
    {
        if (maxSpace != availSpace && legality > 0)
        {
            [self addRoleToPlayer:@"trader-smuggler"];
            if (maxSpace - availSpace > 20 || availSpace == 0)
            {
                if (legality >= 20 || legality >= maxSpace)
                {
                    [self addRoleToPlayer:@"trader-smuggler"];
                }
            }
        }
    }
    [roleWeightFlags removeAllObjects];
 
    [self noteCompassLostTarget];
    if ([self scriptedMisjump]) 
    {
        misjump = YES; // a script could just have changed this to true;
    }
    if (misjump)
    {
        [wormhole setMisjumpWithRange:[self scriptedMisjumpRange]];
    }
    [self witchJumpTo:jumpTarget misjump:misjump];
}

enterWormhole:

- (void) enterWormhole: (WormholeEntity *)  w_hole

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                      :(WormholeEntity *) w_hole
{
    if ([self status] == STATUS_ENTERING_WITCHSPACE
            || [self status] == STATUS_EXITING_WITCHSPACE)
    {
        return; // has already entered a different wormhole
    }
    BOOL misjump = [self scriptedMisjump] || [w_hole withMisjump] || flightPitch == max_flight_pitch || randf() > 0.995;
    wormhole = [w_hole retain];
    [self addScannedWormhole:wormhole];
    [self setStatus:STATUS_ENTERING_WITCHSPACE];
    JSContext *context = OOJSAcquireContext();
    [self setJumpCause:@"wormhole"];
    [self setPreviousSystemID:[self currentSystemID]];
    ShipScriptEvent(context, self, "shipWillEnterWitchspace", STRING_TO_JSVAL(JS_InternString(context, [[self jumpCause] UTF8String])), INT_TO_JSVAL([w_hole destination]));
    OOJSRelinquishContext(context);
    if ([self scriptedMisjump]) 
    {
        misjump = YES; // a script could just have changed this to true;
    }
#ifdef OO_DUMP_PLANETINFO
    misjump = NO;
#endif
    if (misjump && [self scriptedMisjumpRange] != 0.5)
    {
        [w_hole setMisjumpWithRange:[self scriptedMisjumpRange]]; // overrides wormholes, if player also had non-default scriptedMisjumpRange
    }
    [self witchJumpTo:[w_hole destination] misjump:misjump];
}

entryIsCustomEquip:

- (BOOL) entryIsCustomEquip: (NSString *)  entry

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                           :(NSString *)entry
{
    BOOL result = NO;
    if ([entry hasPrefix:@"activate_"] || [entry hasPrefix:@"mode_"])
        result = YES;
    return result;
}

entryIsDictCustomEquip:

- (BOOL) entryIsDictCustomEquip: (NSDictionary *)  dict

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                               :(NSDictionary *)dict
{
    return [self entryIsCustomEquip:[dict oo_stringForKey:KEY_KC_DEFINITION]];
}

entryIsEqualToDefault:

- (BOOL) entryIsEqualToDefault: (NSString*)  key

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                              :(NSString*)key
{
    NSArray *def = (NSArray *)[kdic_check objectForKey:key];
    NSUInteger i;
 
    if ([def count] != [key_list count]) return NO;
    for (i = 0; i < [key_list count]; i++)
    {
        NSDictionary *orig = (NSDictionary *)[def objectAtIndex:i];
        NSDictionary *entrd = (NSDictionary *)[key_list objectAtIndex:i];
        if (![self compareKeyEntries:orig second:entrd]) return NO;
    }
    return YES;
}

entryIsIndexCustomEquip:

- (BOOL) entryIsIndexCustomEquip: (NSUInteger)  idx

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                :(NSUInteger)idx
{
    return [self entryIsCustomEquip:[[keyFunctions objectAtIndex:idx] oo_stringForKey:KEY_KC_DEFINITION]];
}

eqScriptIndexForKey:

- (NSUInteger) eqScriptIndexForKey:

(NSString *)

eq_key

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                                  :(NSString *)eq_key
{
    NSUInteger          i, count = [eqScripts count];
    
    if (eq_key != nil)
    {
        for (i = 0; i < count; i++)
        {
            NSString *key = [[eqScripts oo_arrayAtIndex:i] oo_stringAtIndex:0];
            if ([key isEqualToString: eq_key]) return i;
        }
    }
    
    return count;
}

equipmentList

- (NSArray *) equipmentList

Definition at line 13727 of file PlayerEntity.m.

{
    GuiDisplayGen       *gui = [UNIVERSE gui];
    NSMutableArray      *quip1 = [NSMutableArray array]; // damaged
    NSMutableArray      *quip2 = [NSMutableArray array]; // working
    NSEnumerator        *eqTypeEnum = nil;
    OOEquipmentType     *eqType = nil;
    NSString            *desc = nil;
    NSString            *alldesc = nil;
 
    BOOL prioritiseDamaged = [[gui userSettings] oo_boolForKey:kGuiStatusPrioritiseDamaged defaultValue:YES];
 
    for (eqTypeEnum = [OOEquipmentType reverseEquipmentEnumerator]; (eqType = [eqTypeEnum nextObject]); )
    {
        if ([eqType isVisible])
        {
            if ([eqType canCarryMultiple] && ![eqType isMissileOrMine])
            {
                NSString *damagedIdentifier = [[eqType identifier] stringByAppendingString:@"_DAMAGED"];
                NSUInteger count = 0, okcount = 0;
                okcount = [self countEquipmentItem:[eqType identifier]];
                count = okcount + [self countEquipmentItem:damagedIdentifier];
                if (count == 0)
                {
                    // do nothing
                }
                // all items okay
                else if (count == okcount)
                {
                    // only one installed display normally
                    if (count == 1)
                    {
                        [quip2 addObject:[NSArray arrayWithObjects:[eqType name], [NSNumber numberWithBool:YES], [eqType displayColor], nil]];
                    }
                    // display plural form
                    else
                    {
                        NSString *equipmentName = [eqType name];
                        alldesc = OOExpandKey(@"equipment-plural", count, equipmentName);
                        [quip2 addObject:[NSArray arrayWithObjects:alldesc, [NSNumber numberWithBool:YES], [eqType displayColor], nil]];
                    }
                }
                // all broken, only one installed
                else if (count == 1 && okcount == 0)
                {
                    desc = [NSString stringWithFormat:DESC(@"equipment-@-not-available"), [eqType name]];
                    if (prioritiseDamaged)
                    {
                        [quip1 addObject:[NSArray arrayWithObjects:desc, [NSNumber numberWithBool:NO], [eqType displayColor], nil]];
                    }
                    else
                    {
                        [quip2 addObject:[NSArray arrayWithObjects:desc, [NSNumber numberWithBool:NO], [eqType displayColor], nil]];
                    }
                }
                // some broken, multiple installed
                else
                {
                    NSString *equipmentName = [eqType name];
                    alldesc = OOExpandKey(@"equipment-plural-some-na", okcount, count, equipmentName);
                    if (prioritiseDamaged)
                    {
                        [quip1 addObject:[NSArray arrayWithObjects:alldesc, [NSNumber numberWithBool:NO], [eqType displayColor], nil]];
                    }
                    else
                    {
                        [quip2 addObject:[NSArray arrayWithObjects:alldesc, [NSNumber numberWithBool:NO], [eqType displayColor], nil]];
                    }
                }
            }
            else if ([self hasEquipmentItem:[eqType identifier]])
            {
                [quip2 addObject:[NSArray arrayWithObjects:[eqType name], [NSNumber numberWithBool:YES], [eqType displayColor], nil]];
            }
            else 
            {
                // Check for damaged version
                if ([self hasEquipmentItem:[[eqType identifier] stringByAppendingString:@"_DAMAGED"]])
                {
                    desc = [NSString stringWithFormat:DESC(@"equipment-@-not-available"), [eqType name]];
                    
                    if (prioritiseDamaged) 
                    {
                        [quip1 addObject:[NSArray arrayWithObjects:desc, [NSNumber numberWithBool:NO], [eqType displayColor], nil]];
                    } 
                    else
                    {
                        // just add in to the normal array
                        [quip2 addObject:[NSArray arrayWithObjects:desc, [NSNumber numberWithBool:NO], [eqType displayColor], nil]];
                    }
                }
            }
        }
    }
    
    if (max_passengers > 0)
    {
        desc = [NSString stringWithFormat:DESC_PLURAL(@"equipment-pass-berth-@", max_passengers), max_passengers];
        [quip2 addObject:[NSArray arrayWithObjects:desc, [NSNumber numberWithBool:YES], [[OOEquipmentType equipmentTypeWithIdentifier:@"EQ_PASSENGER_BERTH"] displayColor], nil]];
    }
    
    if (!isWeaponNone(forward_weapon_type))
    {
        desc = [NSString stringWithFormat:DESC(@"equipment-fwd-weapon-@"),[forward_weapon_type name]];
        [quip2 addObject:[NSArray arrayWithObjects:desc, [NSNumber numberWithBool:YES], [forward_weapon_type displayColor], nil]];
    }
    if (!isWeaponNone(aft_weapon_type))
    {
        desc = [NSString stringWithFormat:DESC(@"equipment-aft-weapon-@"),[aft_weapon_type name]];
        [quip2 addObject:[NSArray arrayWithObjects:desc, [NSNumber numberWithBool:YES], [aft_weapon_type displayColor], nil]];
    }
    if (!isWeaponNone(port_weapon_type))
    {
        desc = [NSString stringWithFormat:DESC(@"equipment-port-weapon-@"),[port_weapon_type name]];
        [quip2 addObject:[NSArray arrayWithObjects:desc, [NSNumber numberWithBool:YES], [port_weapon_type displayColor], nil]];
    }
    if (!isWeaponNone(starboard_weapon_type))
    {
        desc = [NSString stringWithFormat:DESC(@"equipment-stb-weapon-@"),[starboard_weapon_type name]];
        [quip2 addObject:[NSArray arrayWithObjects:desc, [NSNumber numberWithBool:YES], [starboard_weapon_type displayColor], nil]];
    }
    
    // list damaged first, then working
    [quip1 addObjectsFromArray:quip2];
    return quip1;
}

equipScreenBackgroundDescriptor

- (NSDictionary *) equipScreenBackgroundDescriptor

Definition at line 9242 of file PlayerEntity.m.

{
    return _equipScreenBackgroundDescriptor;
}

erodeReputation

- (void) erodeReputation

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    int c_good = [reputation oo_intForKey:CONTRACTS_GOOD_KEY];
    int c_bad = [reputation oo_intForKey:CONTRACTS_BAD_KEY];
    int c_unknown = [reputation oo_intForKey:CONTRACTS_UNKNOWN_KEY];
    int p_good = [reputation oo_intForKey:PASSAGE_GOOD_KEY];
    int p_bad = [reputation oo_intForKey:PASSAGE_BAD_KEY];
    int p_unknown = [reputation oo_intForKey:PASSAGE_UNKNOWN_KEY];
    int pl_good = [reputation oo_intForKey:PARCEL_GOOD_KEY];
    int pl_bad = [reputation oo_intForKey:PARCEL_BAD_KEY];
    int pl_unknown = [reputation oo_intForKey:PARCEL_UNKNOWN_KEY];
    
    if (c_unknown < MAX_CONTRACT_REP)
    {
        if (c_bad > 0)
            c_bad--;
        else
        {
            if (c_good > 0)
                c_good--;
        }
        c_unknown++;
    }
    
    if (p_unknown < MAX_CONTRACT_REP)
    {
        if (p_bad > 0)
            p_bad--;
        else
        {
            if (p_good > 0)
                p_good--;
        }
        p_unknown++;
    }
 
    if (pl_unknown < MAX_CONTRACT_REP)
    {
        if (pl_bad > 0)
            pl_bad--;
        else
        {
            if (pl_good > 0)
                pl_good--;
        }
        pl_unknown++;
    }
    
    [reputation setObject:[NSNumber numberWithInt:c_good]       forKey:CONTRACTS_GOOD_KEY];
    [reputation setObject:[NSNumber numberWithInt:c_bad]        forKey:CONTRACTS_BAD_KEY];
    [reputation setObject:[NSNumber numberWithInt:c_unknown]    forKey:CONTRACTS_UNKNOWN_KEY];
    [reputation setObject:[NSNumber numberWithInt:p_good]       forKey:PASSAGE_GOOD_KEY];
    [reputation setObject:[NSNumber numberWithInt:p_bad]        forKey:PASSAGE_BAD_KEY];
    [reputation setObject:[NSNumber numberWithInt:p_unknown]    forKey:PASSAGE_UNKNOWN_KEY];
    [reputation setObject:[NSNumber numberWithInt:pl_good]      forKey:PARCEL_GOOD_KEY];
    [reputation setObject:[NSNumber numberWithInt:pl_bad]       forKey:PARCEL_BAD_KEY];
    [reputation setObject:[NSNumber numberWithInt:pl_unknown]   forKey:PARCEL_UNKNOWN_KEY];
    
}

escapePodRescueTime

- (double) escapePodRescueTime

Definition at line 13727 of file PlayerEntity.m.

{
    return escape_pod_rescue_time;
}

existingNativeSave:

- (BOOL) existingNativeSave: (NSString *)  cdrName

implementation

Provided by category PlayerEntity(OOLoadSavePrivate).

Definition at line 1011 of file PlayerEntityLoadSave.m.

                           : (NSString *)cdrName
{
    NSString*   dir = [[UNIVERSE gameController] playerFileDirectory];
    
    NSString *savePath=[dir stringByAppendingPathComponent:[cdrName stringByAppendingPathExtension:@"oolite-save"]];
    return [[NSFileManager defaultManager] fileExistsAtPath:savePath];
}

expandMessage:

- (NSString *) expandMessage: (NSString *)  valueString

implementation

Provided by category PlayerEntity(ScriptingPrivate).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                            :(NSString *)valueString
{
    Random_Seed very_random_seed;
    very_random_seed.a = rand() & 255;
    very_random_seed.b = rand() & 255;
    very_random_seed.c = rand() & 255;
    very_random_seed.d = rand() & 255;
    very_random_seed.e = rand() & 255;
    very_random_seed.f = rand() & 255;
    seed_RNG_only_for_planet_description(very_random_seed);
    NSString* expandedMessage = OOExpand(valueString);
    return [self replaceVariablesInString: expandedMessage];
}

expandScriptRightHandSide:

- (NSString *) expandScriptRightHandSide: (NSArray *)  rhsComponents

implementation

Provided by category PlayerEntity(ScriptingPrivate).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                                        :(NSArray *)rhsComponents
{
    NSMutableArray          *result = nil;
    NSArray                 *component = nil;
    NSString                *value = nil;
    
    result = [NSMutableArray arrayWithCapacity:[rhsComponents count]];
    
    foreach (component, rhsComponents)
    {
        /*  Each component is a two-element array. The second element is a
            string. The first element is a boolean indicating whether the
            string is a selector (true) or a literal (false).
            
            All valid selectors return a string or an NSNumber; in either
            case, -description gives us a useful value to substitute into
            the expanded string.
        */
        
        value = [component oo_stringAtIndex:1];
        
        if ([[component objectAtIndex:0] boolValue])
        {
            value = [[self performSelector:NSSelectorFromString(value)] description];
            if (value == nil)  value = @"(null)";   // for backwards compatibility
        }
        
        [result addObject:value];
    }
    
    return [result componentsJoinedByString:@" "];
}

fastEquipmentA

- (NSString *) fastEquipmentA

Definition at line 13727 of file PlayerEntity.m.

{
    return _fastEquipmentA;
}

Referenced by PlayerShipGetProperty().

Here is the caller graph for this function:

fastEquipmentB

- (NSString *) fastEquipmentB

Definition at line 13727 of file PlayerEntity.m.

{
    return _fastEquipmentB;
}

Referenced by PlayerShipGetProperty().

Here is the caller graph for this function:

findIndexOfCommander:

- (int) findIndexOfCommander: (NSString *)  cdrName

implementation

Provided by category PlayerEntity(OOLoadSavePrivate).

Definition at line 1011 of file PlayerEntityLoadSave.m.

                            : (NSString *)cdrName
{
    unsigned i;
    for (i=0; i < [cdrDetailArray count]; i++)
    {
        NSString *currentName = [[cdrDetailArray oo_dictionaryAtIndex: i] oo_stringForKey:@"player_save_name" defaultValue:[[cdrDetailArray oo_dictionaryAtIndex: i] oo_stringForKey:@"player_name"]];
        if([cdrName compare: currentName] == NSOrderedSame)
        {
            return i;
        }
    }
    
    // not found!
    return -1;
}

fireECM

- (BOOL) fireECM

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    if ([super fireECM])
    {
        ecm_in_operation = YES;
        ecm_start_time = [UNIVERSE getTime];
        return YES;
    }
    else
    {
        return NO;
    }
}

fireMainWeapon

- (BOOL) fireMainWeapon

Definition at line 13727 of file PlayerEntity.m.

{
    OOWeaponType weapon_to_be_fired = [self currentWeapon];
 
    if (![self weaponsOnline])
    {
        return NO;
    }
    
    if (weapon_temp / PLAYER_MAX_WEAPON_TEMP >= WEAPON_COOLING_CUTOUT)
    {
        [self playWeaponOverheated:[[self currentLaserOffset] oo_vectorAtIndex:0]];
        [UNIVERSE addMessage:DESC(@"weapon-overheat") forCount:3.0];
        return NO;
    }
 
    if (isWeaponNone(weapon_to_be_fired))
    {
        return NO;
    }
 
    [self currentWeaponStats];
 
    NSUInteger multiplier = 1;
    if (_multiplyWeapons)
    {
        // multiple fitted
        multiplier = [[self laserPortOffset:currentWeaponFacing] count];
    }
    
    if (energy <= weapon_energy_use * multiplier)
    {
        [UNIVERSE addMessage:DESC(@"weapon-out-of-juice") forCount:3.0];
        return NO;
    }
 
    using_mining_laser = [weapon_to_be_fired isMiningLaser];
 
    energy -= weapon_energy_use * multiplier;
 
    switch (currentWeaponFacing)
    {
        case WEAPON_FACING_FORWARD:
            forward_weapon_temp += weapon_shot_temperature * multiplier;
            forward_shot_time = 0.0;
            break;
            
        case WEAPON_FACING_AFT:
            aft_weapon_temp += weapon_shot_temperature * multiplier;
            aft_shot_time = 0.0;
            break;
            
        case WEAPON_FACING_PORT:
            port_weapon_temp += weapon_shot_temperature * multiplier;
            port_shot_time = 0.0;
            break;
            
        case WEAPON_FACING_STARBOARD:
            starboard_weapon_temp += weapon_shot_temperature * multiplier;
            starboard_shot_time = 0.0;
            break;
            
        case WEAPON_FACING_NONE:
            break;
    }
    
    BOOL    weaponFired = NO;
    if (!isWeaponNone(weapon_to_be_fired))
    {
        if (![weapon_to_be_fired isTurretLaser])
        {
            [self fireLaserShotInDirection:currentWeaponFacing weaponIdentifier:[[self currentWeapon] identifier]];
            weaponFired = YES;
        }
        else
        {
            // nothing: compatible with previous versions
        }
    }
    
    if (weaponFired && cloaking_device_active && cloakPassive)
    {
        [self deactivateCloakingDevice];
    }   
    
    return weaponFired;
}

fireMissile

- (ShipEntity *) fireMissile

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    ShipEntity  *missile = missile_entity[activeMissile];   // retain count is 1
    NSString    *identifier = [missile primaryRole];
    ShipEntity  *firedMissile = nil;
 
    if (missile == nil) return nil;
    
    if (![self weaponsOnline])  return nil;
    
    // check if we were cloaked before firing the missile - can't use
    // cloaking_device_active directly because fireMissilewithIdentifier: andTarget:
    // will reset it in case passive cloak is set - Nikos 20130313
    BOOL cloakedPriorToFiring = cloaking_device_active;
    
    launchingMissile = YES;
    replacingMissile = NO;
 
    if ([missile isMine] && (missile_status != MISSILE_STATUS_SAFE))
    {
        firedMissile = [self launchMine:missile];
        if (!replacingMissile) [self removeFromPylon:activeMissile];
        if (firedMissile != nil) [self playMineLaunched:[self missileLaunchPosition] weaponIdentifier:identifier];
    }
    else
    {
        if (missile_status != MISSILE_STATUS_TARGET_LOCKED) return nil;
        //  release this before creating it anew in fireMissileWithIdentifier
        firedMissile = [self fireMissileWithIdentifier:identifier andTarget:[missile primaryTarget]];
 
        if (firedMissile != nil)
        {
            if (!replacingMissile) [self removeFromPylon:activeMissile];
            [self playMissileLaunched:[self missileLaunchPosition] weaponIdentifier:identifier];
        }
    }
    
    if (cloakedPriorToFiring && cloakPassive)
    {
        // fireMissilewithIdentifier: andTarget: has already taken care of deactivating
        // the cloak in the case of missiles by the time we get here, but explicitly
        // calling deactivateCloakingDevice is needed in order to be covered fully with mines too
        [self deactivateCloakingDevice];
    }
    
    replacingMissile = NO;
    launchingMissile = NO;
    
    return firedMissile;
}

fleeingStatus

- (OOPlayerFleeingStatus) fleeingStatus

Definition at line 13727 of file PlayerEntity.m.

{
    return fleeing_status;
}

forwardShieldLevel

- (GLfloat) forwardShieldLevel

Definition at line 13727 of file PlayerEntity.m.

{
    return forward_shield;
}

forwardShieldRechargeRate

- (float) forwardShieldRechargeRate

Definition at line 13727 of file PlayerEntity.m.

{
    return forward_shield_recharge_rate;
}

foundEquipment_bool

- (NSString *) foundEquipment_bool

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return (found_equipment)? @"YES" : @"NO";
}

fuelLeakRate

- (float) fuelLeakRate

Definition at line 13727 of file PlayerEntity.m.

{
    return fuel_leak_rate;
}

fuelLeakRate_number

- (NSNumber *) fuelLeakRate_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithFloat:[self fuelLeakRate]];
}

fuelLevel_number

- (NSNumber *) fuelLevel_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithFloat:floor(0.1 * fuel)];
}

fuelRequiredForJump

- (OOFuelQuantity) fuelRequiredForJump

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    return 10.0 * MAX(0.1, [self hyperspaceJumpDistance]);
}

galacticHyperspaceBehaviour

- (OOGalacticHyperspaceBehaviour) galacticHyperspaceBehaviour

galacticHyperspaceFixedCoords

- (NSPoint) galacticHyperspaceFixedCoords

galaxy_coordinates

- (NSPoint) galaxy_coordinates

galaxyNumber

- (OOGalaxyID) galaxyNumber

Definition at line 13727 of file PlayerEntity.m.

{
    return galaxy_number;
}

gameOverFadeToBW

- (void) gameOverFadeToBW

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    float secondsToBWFadeOut = [[NSUserDefaults standardUserDefaults] oo_floatForKey:@"gameover-seconds-to-bw-fadeout" defaultValue:5.0f];
    if ([UNIVERSE detailLevel] >= DETAIL_LEVEL_SHADERS && secondsToBWFadeOut > 0.0f)
    {
        MyOpenGLView *gameView = [UNIVERSE gameView];
        static float originalColorSaturation = -1.0f;
        if (originalColorSaturation == -1.0f)  originalColorSaturation = [gameView colorSaturation];
        if ([self shotTime] < secondsToBWFadeOut)
        {
            // fade to black & white within secondsToBWFadeOut, independently of
            // frame rate and original color saturation
            if (fps_counter != 0)
            {
                [gameView adjustColorSaturation:-(originalColorSaturation * (1.0f / secondsToBWFadeOut) * [UNIVERSE timeAccelerationFactor] / fps_counter)];
            }
        }
        
        if ([self shotTime] > kDeadResetTime)
        {
            // make sure to subtract the current saturation because if the user presses space to skip
            // the game over screen before the transition to b/w has been completed, whatever is left
            // will be added to the original saturation, resulting in an oversaturated image
            [gameView adjustColorSaturation:originalColorSaturation - [gameView colorSaturation]];
            originalColorSaturation = -1.0f;
        }
    }
}

getCustomEquipArray:

- (NSArray *) getCustomEquipArray: (NSString *)  key_def

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                 :(NSString *)key_def
{
    NSString *eq = nil;
    NSUInteger i;
    NSString *key;
    if ([key_def hasPrefix:@"activate_"]) 
    {
        eq = [key_def stringByReplacingOccurrencesOfString:@"activate_" withString:@""];
        key = CUSTOMEQUIP_KEYACTIVATE;
    }
    if ([key_def hasPrefix:@"mode_"]) 
    {
        eq = [key_def stringByReplacingOccurrencesOfString:@"mode_" withString:@""];
        key = CUSTOMEQUIP_KEYMODE;
    }
    if (eq == nil) return nil;
    for (i = 0; i < [customEquipActivation count]; i++)
    {
        if ([[[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPKEY] isEqualToString:eq])
        {
            return [[customEquipActivation objectAtIndex:i] oo_arrayForKey:key];
        }
    }
    return nil;
}

getCustomEquipIndex:

- (NSUInteger) getCustomEquipIndex: (NSString *)  key_def

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                  :(NSString *)key_def
{
    NSString *eq = nil;
    NSUInteger i;
    if ([key_def hasPrefix:@"activate_"]) 
    {
        eq = [key_def stringByReplacingOccurrencesOfString:@"activate_" withString:@""];
    }
    if ([key_def hasPrefix:@"mode_"]) 
    {
        eq = [key_def stringByReplacingOccurrencesOfString:@"mode_" withString:@""];
    }
    if (eq == nil) return -1;
    for (i = 0; i < [customEquipActivation count]; i++)
    {
        if ([[[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPKEY] isEqualToString:eq])
        {
            return i;
        }
    }
    return -1;
}

getCustomEquipKeyDefType:

- (NSString *) getCustomEquipKeyDefType: (NSString *)  key_def

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                       :(NSString *)key_def
{
    if ([key_def hasPrefix:@"activate_"]) 
    {
        return CUSTOMEQUIP_KEYACTIVATE;
    }
    if ([key_def hasPrefix:@"mode_"]) 
    {
        return CUSTOMEQUIP_KEYMODE;
    }
    return @"";
}

getDestroyedBy:damageType:

- (void) getDestroyedBy: (Entity *)  whom damageType: (OOShipDamageType)  type

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                       :(Entity *)whom damageType:(OOShipDamageType)type
{
    if ([self isDocked])  return;   // Can't die while docked. (Doing so would cause breakage elsewhere.)
    
    OOLog(@"player.ship.damage",  @"Player destroyed by %@ due to %@", whom, OOStringFromShipDamageType(type)); 
    
    if (![[UNIVERSE gameController] playerFileToLoad])
    {
        [[UNIVERSE gameController] setPlayerFileToLoad: save_path]; // make sure we load the correct game
    }
    
    energy = 0.0f;
    afterburner_engaged = NO;
    [self disengageAutopilot];
 
    [UNIVERSE setDisplayText:NO];
    [UNIVERSE setViewDirection:VIEW_AFT];
    
    // Let scripts know the player died.
    [self noteKilledBy:whom damageType:type]; // called before exploding, consistant with npc ships.
    
    [self becomeLargeExplosion:4.0]; // also sets STATUS_DEAD
    [self moveForward:100.0];
    
    flightSpeed = 160.0f;
    velocity = kZeroVector;
    flightRoll = 0.0;
    flightPitch = 0.0;
    flightYaw = 0.0;
    [[UNIVERSE messageGUI] clear];      // No messages for the dead.
    [self suppressTargetLost];          // No target lost messages when dead.
    [self playGameOver];
    [UNIVERSE setBlockJSPlayerShipProps:YES];   // Treat JS player as stale entity.
    [self removeAllEquipment];          // No scooping / equipment damage when dead.
    [self loseTargetStatus];
    [self showGameOver];
}

getDockingClearanceStatus

- (OODockingClearanceStatus) getDockingClearanceStatus

Definition at line 9242 of file PlayerEntity.m.

{
    return dockingClearanceStatus;
}

getFined

- (void) getFined

Definition at line 9242 of file PlayerEntity.m.

{
    if (legalStatus == 0)  return;              // nothing to pay for
    
    OOGovernmentID local_gov = [[UNIVERSE currentSystemData] oo_intForKey:KEY_GOVERNMENT];
    if ([UNIVERSE inInterstellarSpace])  local_gov = 1; // equivalent to Feudal. I'm assuming any station in interstellar space is military. -- Ahruman 2008-05-29
    OOCreditsQuantity fine = 500 + ((local_gov < 2 || local_gov > 5) ? 500 : 0);
    fine *= legalStatus;
    if (fine > credits)
    {
        int payback = (int)(legalStatus * credits / fine);
        [self setBounty:(legalStatus-payback) withReason:kOOLegalStatusReasonPaidFine];
        credits = 0;
    }
    else
    {
        [self setBounty:0 withReason:kOOLegalStatusReasonPaidFine];
        credits -= fine;
    }
    
    // one of the fined-@-credits strings includes expansion tokens
    NSString *fined_message = [NSString stringWithFormat:OOExpandKey(@"fined-@-credits"), OOCredits(fine)];
    [self addMessageToReport:fined_message];
    [UNIVERSE forceWitchspaceEntries];
    ship_clock_adjust += 24 * 3600; // take up a day
}

getFirstKeyCode:

- (int) getFirstKeyCode:

(NSArray*)

key_def

Provided by category PlayerEntity(Controls).

Definition at line 164 of file PlayerEntityControls.m.

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

getKeyBindingDescription:

- (NSString *) getKeyBindingDescription:

(NSArray *)

keyList

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                       :(NSArray *) keyList
{
    NSUInteger i = 0;
    NSMutableString *final = [NSMutableString string];
    for (i = 0; i < [keyList count]; i++) {
        if (i != 0) final = [NSMutableString stringWithFormat:@"%@ or ", final];
        NSDictionary *def = [keyList objectAtIndex:i];
        NSString *key = [def objectForKey:@"key"];
        OOKeyCode k_int = (OOKeyCode)[key integerValue];
        NSString *desc = [self keyCodeDescription:k_int];
        // 0 = key not set
        if (k_int != 0) {
            if ([[def objectForKey:@"mod2"] boolValue] == YES) final = [NSMutableString stringWithFormat:@"%@%@+", final, keyMod2Text];
            if ([[def objectForKey:@"mod1"] boolValue] == YES) final = [NSMutableString stringWithFormat:@"%@%@+", final, keyMod1Text];
            if ([[def objectForKey:@"shift"] boolValue] == YES) final = [NSMutableString stringWithFormat:@"%@%@+", final, keyShiftText];
            final = [NSMutableString stringWithFormat:@"%@%@", final, desc];
        }
    }
    return final;
}

getMissionDestinations

- (NSMutableDictionary *) getMissionDestinations

Definition at line 9242 of file PlayerEntity.m.

{
    return missionDestinations;
}

Referenced by MissionGetProperty().

Here is the caller graph for this function:

getTargetDockStation

- (StationEntity *) getTargetDockStation

Definition at line 13727 of file PlayerEntity.m.

{
    return targetDockStation;
}

gui_screen_string

- (NSString *) gui_screen_string

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    return OOStringFromGUIScreenID(gui_screen);
}

guiScreen

- (OOGUIScreenID) guiScreen

Definition at line 9242 of file PlayerEntity.m.

{
    return gui_screen;
}

Referenced by GlobalPauseGame().

Here is the caller graph for this function:

handleAutopilotOn:

- (void) handleAutopilotOn: (BOOL)  fastDocking

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

                          :(BOOL)fastDocking
{
    NSString    *message = nil;
    
    // Check alert condition - on red alert, abort
    // -- but only for fast docking
    if (fastDocking && ([self alertCondition] == ALERT_CONDITION_RED))
    {
        [self playAutopilotCannotDockWithTarget];
        message = OOExpandKey(@"autopilot-red-alert");
        goto abort;
    }
    
    Entity *target = [self primaryTarget];
    // If target isn't dockable, check for nearby stations
    if (![target isStation])
    {
        Universe  *uni        = UNIVERSE;
        Entity    **entities  = uni->sortedEntities;    // grab the public sorted list
        int       nStations   = 0;
        unsigned  i;
        
        for (i = 0; i < uni->n_entities && nStations < 2; i++)
        {
            if (entities[i]->isStation && [entities[i] isKindOfClass:[StationEntity class]] &&
                entities[i]->zero_distance <= SCANNER_MAX_RANGE2)
            {
                nStations++;
                target = entities[i];
            }
        }
        // If inside the Aegis, dock with the main station.
        // If we found one target, dock with it.
        // If outside the Aegis and we found multiple targets, abort.
        
        if ([self withinStationAegis] && legalStatus <= 50)
        {
            target = [UNIVERSE station];
        }
        else if (nStations != 1)
        {
            if (nStations == 0)
            {
                [self playAutopilotOutOfRange];
                message = OOExpandKey(@"autopilot-out-of-range");
            }
            else
            {
                [self playAutopilotCannotDockWithTarget];
                message = OOExpandKey(@"autopilot-multiple-targets");
            }
            goto abort;
        }
    }
    
    // We found a dockable, check whether we can dock with it
    // NSAssert([target isKindOfClass:[StationEntity class]], @"Expected entity with isStation flag set to be a station.");     // no need for asserts. Tested enough already.
    StationEntity *ts = (StationEntity *)target;
    NSString *stationName = [ts displayName];
    
    // If station is not transmitting docking instructions, we cannot use autopilot.
    if (![ts allowsAutoDocking])
    {
        [self playAutopilotCannotDockWithTarget];
        message = OOExpandKey(@"autopilot-station-does-not-allow-autodocking", stationName);
    }
    // Deny if station is hostile or player is a fugitive trying to dock at the main station.
    else if ((legalStatus > 50 && ts == [UNIVERSE station]) || [ts isHostileTo:self])
    {
        [self playAutopilotCannotDockWithTarget];
        message = OOExpandKey((ts == [UNIVERSE station]) ? @"autopilot-denied" : @"autopilot-target-docking-instructions-denied", stationName);
    }
    // If we're fast-docking, perform the docking logic
    else if (fastDocking && [ts allowsFastDocking])
    {
        // check whether there are docks that do not accept docking - even one such dock will result in rejection
        NSEnumerator    *subEnum = nil;
        DockEntity* sub = nil;
        for (subEnum = [ts dockSubEntityEnumerator]; (sub = [subEnum nextObject]); )
        {
            // TOO_BIG_TO_DOCK issued when docks are scripted to reject docking
            if([[sub canAcceptShipForDocking:self] isEqualToString:@"TOO_BIG_TO_DOCK"]) 
            {
                message = OOExpandKey((ts == [UNIVERSE station]) ? @"autopilot-denied" : @"autopilot-target-docking-instructions-denied", stationName);
                goto abort;
            }
        }
    
        if (legalStatus > 0)
        {
            // there's a slight chance you'll be fined for your past offences when autodocking
            int fine_chance = ranrot_rand() & 0x03ff;   //  0..1023
            int government = 1 + [[UNIVERSE currentSystemData] oo_intForKey:KEY_GOVERNMENT];    // 1..8
            if ([UNIVERSE inInterstellarSpace])  government = 2;    // equivalent to Feudal. I'm assuming any station in interstellar space is military. -- Ahruman 2008-05-29
            fine_chance /= government;
            if (fine_chance < legalStatus)
            {
                [self markForFines];
            }
        }
        
        [self setDockingClearanceStatus:DOCKING_CLEARANCE_STATUS_GRANTED];
        
        [UNIVERSE forceWitchspaceEntries];
        ship_clock_adjust += 1200.0;            // 20 minutes penalty to enter dock
        ident_engaged = NO;
        [self safeAllMissiles];
        [UNIVERSE setViewDirection:VIEW_FORWARD];
        [self enterDock:ts];
    }
    else
    {
        // Standard docking - engage autopilot
        [self engageAutopilotToStation:ts];
        message = OOExpandKey(@"autopilot-on");
    }
    
abort:
    // Clean-up code
    if (message != nil) [UNIVERSE addMessage:message forCount:4.5];
    return;
}

handleButtonIdent

- (void) handleButtonIdent

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

{
    // Clear current target if we're already in Ident mode
    if (ident_engaged)  [self noteLostTarget];
    
    [self safeAllMissiles];
    ident_engaged = YES;
    if ([self primaryTarget] == nil)
    {
        [self playIdentOn];
        [UNIVERSE addMessage:OOExpandKey(@"ident-on") forCount:2.0];
    }
    else
    {
        [self playIdentLockedOn];
        [self printIdentLockedOnForMissile:NO];
    }
}

handleButtonTargetMissile

- (void) handleButtonTargetMissile

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

{
    if (![self weaponsOnline])
    {
        [self handleButtonIdent];
        return;
    }
    
    // Clear current target if we're already in Missile Targeting mode
    if (missile_status != MISSILE_STATUS_SAFE)
    {
        [self noteLostTarget];
    }
    
    // Arm missile and check for missile lock
    missile_status = MISSILE_STATUS_ARMED;
    if ([missile_entity[activeMissile] isMissile])
    {
        if ([[self primaryTarget] isShip])
        {
            missile_status = MISSILE_STATUS_TARGET_LOCKED;
            [missile_entity[activeMissile] addTarget:[self primaryTarget]];
            [self printIdentLockedOnForMissile:YES];
            [self playMissileLockedOn];
        }
        else
        {
            // if it's nil, that means it was lost earlier
            if ([self primaryTarget] != nil)
            {
                [self noteLostTarget];
            }
            [missile_entity[activeMissile] noteLostTarget];
            NSString *weaponName = [missile_entity[activeMissile] name];
            [UNIVERSE addMessage:OOExpandKey(@"missile-armed", weaponName) forCount:2.0];
            [self playMissileArmed];
        }
    }
    else if ([missile_entity[activeMissile] isMine])
    {
        NSString *weaponName = [missile_entity[activeMissile] name];
        [UNIVERSE addMessage:OOExpandKey(@"mine-armed", weaponName) forCount:2.0];
        [self playMineArmed];
    }
    ident_engaged = NO;
}

handleGameOptionsScreenKeys

- (void) handleGameOptionsScreenKeys

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

{
    MyOpenGLView        *gameView = [UNIVERSE gameView];
    GuiDisplayGen       *gui = [UNIVERSE gui];
    GUI_ROW_INIT(gui);
    
    [self handleGUIUpDownArrowKeys];
    OOGUIRow guiSelectedRow = [gui selectedRow];
    BOOL selectKeyPress = ([self checkKeyPress:n_key_gui_select]||[gameView isDown:gvMouseDoubleClick]);
    if ([gameView isDown:gvMouseDoubleClick])  [gameView clearMouse];
    
    if ((guiSelectedRow == GUI_ROW(GAME,STICKMAPPER)) && selectKeyPress)
    {
        selFunctionIdx = 0;
        [self resetStickFunctions]; // reset the list of stick functions, so changes in oxp equipment are reflected
        [self setGuiToStickMapperScreen: 0 resetCurrentRow: YES];
    }
    if ((guiSelectedRow == GUI_ROW(GAME,KEYMAPPER)) && selectKeyPress)
    {
        selFunctionIdx = 0;
        [self resetKeyFunctions]; // reset the list of key functions, so changes in oxp equipment are reflected
        [self setGuiToKeyMapperScreen: 0 resetCurrentRow: YES];
    }
    
    
#if OOLITE_WINDOWS
    if ([gameView hdrOutput])
    {
        if ((guiSelectedRow == GUI_ROW(GAME,HDRMAXBRIGHTNESS))&&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left])))
        {
            if (!hdrMaxBrightnessControlPressed)
            {
                int         direction = ([self checkKeyPress:n_key_gui_arrow_right]) ? 1 : -1;
                NSArray     *brightnesses = [[UNIVERSE descriptions] oo_arrayForKey: @"hdr_maxBrightness_array"];
                int         brightnessIdx = [brightnesses indexOfObject:[NSString stringWithFormat:@"%d", (int)[gameView hdrMaxBrightness]]];
                
                if (brightnessIdx == NSNotFound)
                {
                    OOLogWARN(@"hdr.maxBrightness.notFound", @"%@", @"couldn't find current max brightness setting, switching to lowest.");
                    brightnessIdx = 0;
                }
                
                brightnessIdx += direction;
                int count = [brightnesses count];
                if (brightnessIdx < 0)
                    brightnessIdx = count - 1;
                if (brightnessIdx >= count)
                    brightnessIdx = 0;
                
                int brightnessValue = [brightnesses oo_intAtIndex:brightnessIdx];
                
                // warp if the value we got is out of expected limits; can be the case if user has
                // manually modified the hdr_maxBrightness_array in descriptions.plist
                if (brightnessValue < MIN_HDR_MAXBRIGHTNESS)  brightnessValue = direction == -1 ? MAX_HDR_MAXBRIGHTNESS : MIN_HDR_MAXBRIGHTNESS;
                if (brightnessValue > MAX_HDR_MAXBRIGHTNESS)  brightnessValue = direction == 1 ? MIN_HDR_MAXBRIGHTNESS : MAX_HDR_MAXBRIGHTNESS;
                    
                [gameView setHDRMaxBrightness:(float)brightnessValue];
                NSString *maxBrightnessString = OOExpandKey(@"gameoptions-hdr-maxbrightness", brightnessValue);
                                                                                
                [gui setText:maxBrightnessString forRow:GUI_ROW(GAME,HDRMAXBRIGHTNESS)  align:GUI_ALIGN_CENTER];
                
                hdrMaxBrightnessControlPressed = YES;
            }
        }
        else
            hdrMaxBrightnessControlPressed = NO;
    }
#endif
    
    
#if OO_RESOLUTION_OPTION
    if (!switching_resolution &&
        guiSelectedRow == GUI_ROW(GAME,DISPLAY) &&
        ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_arrow_left]))
    {
        GameController  *controller = [UNIVERSE gameController];
        int             direction = ([self checkKeyPress:n_key_gui_arrow_right]) ? 1 : -1;
        NSInteger       displayModeIndex = [controller indexOfCurrentDisplayMode];
        NSArray         *modes = [controller displayModes];
        
        if (displayModeIndex == (NSInteger)NSNotFound)
        {
            OOLogWARN(@"graphics.mode.notFound", @"%@", @"couldn't find current fullscreen setting, switching to default.");
            displayModeIndex = 0;
        }
        
        displayModeIndex = displayModeIndex + direction;
        int count = [modes count];
        if (displayModeIndex < 0)
            displayModeIndex = count - 1;
        if (displayModeIndex >= count)
            displayModeIndex = 0;
        
        NSDictionary    *mode = [modes objectAtIndex:displayModeIndex];
        int modeWidth = [mode oo_intForKey:kOODisplayWidth];
        int modeHeight = [mode oo_intForKey:kOODisplayHeight];
        int modeRefresh = [mode oo_intForKey:kOODisplayRefreshRate];
        [controller setDisplayWidth:modeWidth Height:modeHeight Refresh:modeRefresh];
 
        NSString *displayModeString = [self screenModeStringForWidth:modeWidth height:modeHeight refreshRate:modeRefresh];
        
        [self playChangedOption];
        [gui setText:displayModeString  forRow:GUI_ROW(GAME,DISPLAY)  align:GUI_ALIGN_CENTER];
        switching_resolution = YES;
        
#if OOLITE_SDL
        /*  TODO: The gameView for the SDL game currently holds and
         sets the actual screen resolution (controller just stores
         it). This probably ought to change. */
        [gameView setScreenSize: displayModeIndex]; // changes fullscreen mode immediately
#endif
    }
    if (switching_resolution && ![self checkKeyPress:n_key_gui_arrow_right] && ![self checkKeyPress:n_key_gui_arrow_left] && !selectKeyPress)
    {
        switching_resolution = NO;
    }
#endif  // OO_RESOLUTION_OPTION
    
#if OOLITE_SPEECH_SYNTH
 
    if ((guiSelectedRow == GUI_ROW(GAME,SPEECH))&&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left])))
    {
        if (!speech_settings_pressed)
        {
            if ([self checkKeyPress:n_key_gui_arrow_right] && isSpeechOn < OOSPEECHSETTINGS_ALL)
            {
                ++isSpeechOn;
                [self playChangedOption];
                speech_settings_pressed = YES;
            }
            else if ([self checkKeyPress:n_key_gui_arrow_left] && isSpeechOn > OOSPEECHSETTINGS_OFF)
            {
                speech_settings_pressed = YES;
                --isSpeechOn;
                [self playChangedOption];
            }
            if (speech_settings_pressed)
            {
                NSString *message = nil;
                switch (isSpeechOn)
                {
                case OOSPEECHSETTINGS_OFF:
                    message = DESC(@"gameoptions-spoken-messages-no");
                    break;
                case OOSPEECHSETTINGS_COMMS:
                    message = DESC(@"gameoptions-spoken-messages-comms");
                    break;
                case OOSPEECHSETTINGS_ALL:
                    message = DESC(@"gameoptions-spoken-messages-yes");
                    break;
                }
                [gui setText:message forRow:GUI_ROW(GAME,SPEECH) align:GUI_ALIGN_CENTER];
 
                if (isSpeechOn == OOSPEECHSETTINGS_ALL)
                {
                    [UNIVERSE stopSpeaking];
                    [UNIVERSE startSpeakingString:message];
                }
            }
        }
    }
    else
    {
        speech_settings_pressed = NO;
    }
#if OOLITE_ESPEAK
    if (guiSelectedRow == GUI_ROW(GAME,SPEECH_LANGUAGE))
    {
        if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_arrow_left])
        {
            if (!speechVoiceSelectKeyPressed || script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL)
            {
                [self playChangedOption];
                if ([self checkKeyPress:n_key_gui_arrow_right])
                    voice_no = [UNIVERSE nextVoice: voice_no];
                else
                    voice_no = [UNIVERSE prevVoice: voice_no];
                [UNIVERSE setVoice: voice_no withGenderM:voice_gender_m];
                NSString *voiceName = [UNIVERSE voiceName:voice_no];
                NSString *message = OOExpandKey(@"gameoptions-voice-name", voiceName);
                [gui setText:message forRow:GUI_ROW(GAME,SPEECH_LANGUAGE) align:GUI_ALIGN_CENTER];
                if (isSpeechOn == OOSPEECHSETTINGS_ALL)
                {
                    [UNIVERSE stopSpeaking];
                    [UNIVERSE startSpeakingString:[UNIVERSE voiceName: voice_no]];
                }
                timeLastKeyPress = script_time;
            }
            speechVoiceSelectKeyPressed = YES;
        }
        else
            speechVoiceSelectKeyPressed = NO;
    }
 
    if (guiSelectedRow == GUI_ROW(GAME,SPEECH_GENDER))
    {
        if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_arrow_left])
        {
            if (!speechGenderSelectKeyPressed)
            {
                [self playChangedOption];
                BOOL m = [self checkKeyPress:n_key_gui_arrow_right];
                if (m != voice_gender_m)
                {
                    voice_gender_m = m;
                    [UNIVERSE setVoice:voice_no withGenderM:voice_gender_m];
                    NSString *message = [NSString stringWithFormat:@"%@", DESC(voice_gender_m ? @"gameoptions-voice-M" : @"gameoptions-voice-F")];
                    [gui setText:message forRow:GUI_ROW(GAME,SPEECH_GENDER) align:GUI_ALIGN_CENTER];
                    if (isSpeechOn == OOSPEECHSETTINGS_ALL)
                    {
                        [UNIVERSE stopSpeaking];
                        [UNIVERSE startSpeakingString:[UNIVERSE voiceName: voice_no]];
                    }
                }
            }
            speechGenderSelectKeyPressed = YES;
        }
        else
            speechGenderSelectKeyPressed = NO;
    }
#endif
#endif
    
    if ((guiSelectedRow == GUI_ROW(GAME,MUSIC))&&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left])))
    {
        if (!musicModeKeyPressed)
        {
            OOMusicController   *musicController = [OOMusicController sharedController];
            int                 initialMode = [musicController mode];
            int                 mode = initialMode;
            
            if ([self checkKeyPress:n_key_gui_arrow_right])  mode++;
            if ([self checkKeyPress:n_key_gui_arrow_left])  mode--;
            
            [musicController setMode:MAX(mode, 0)];
            
            if ((int)[musicController mode] != initialMode)
            {
                [self playChangedOption];
                NSString *musicMode = [UNIVERSE descriptionForArrayKey:@"music-mode" index:[[OOMusicController sharedController] mode]];
                NSString *message = OOExpandKey(@"gameoptions-music-mode", musicMode);
                [gui setText:message forRow:GUI_ROW(GAME,MUSIC) align:GUI_ALIGN_CENTER];
            }
        }
        musicModeKeyPressed = YES;
    }
    else  musicModeKeyPressed = NO;
    
    if ((guiSelectedRow == GUI_ROW(GAME,AUTOSAVE))&&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left])))
    {
        if ([self checkKeyPress:n_key_gui_arrow_right] != [UNIVERSE autoSave])
            [self playChangedOption];
        [UNIVERSE setAutoSave:[self checkKeyPress:n_key_gui_arrow_right]];
        if ([UNIVERSE autoSave])
        {
            // if just enabled, we want to autosave immediately
            [UNIVERSE setAutoSaveNow:YES];
            [gui setText:DESC(@"gameoptions-autosave-yes")  forRow:GUI_ROW(GAME,AUTOSAVE)  align:GUI_ALIGN_CENTER];
        }
        else
        {
            [UNIVERSE setAutoSaveNow:NO];
            [gui setText:DESC(@"gameoptions-autosave-no")   forRow:GUI_ROW(GAME,AUTOSAVE)  align:GUI_ALIGN_CENTER];
        }
    }
 
    if ((guiSelectedRow == GUI_ROW(GAME,VOLUME))
        &&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left]))
        &&[OOSound respondsToSelector:@selector(masterVolume)])
    {
        if ((!volumeControlPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
        {
            BOOL rightKeyDown = [self checkKeyPress:n_key_gui_arrow_right];
            BOOL leftKeyDown = [self checkKeyPress:n_key_gui_arrow_left];
            double volume = 100.0 * [OOSound masterVolume];
            int vol = (volume / 5.0 + 0.5);
            if (rightKeyDown) vol++;
            if (leftKeyDown) vol--;
            vol = (int)OOClampInteger(vol, 0, 20);
            [OOSound setMasterVolume: 0.05 * vol];
            [self playChangedOption];
#if OOLITE_ESPEAK
            espeak_SetParameter(espeakVOLUME, vol * 5, 0);
#endif
            if (vol > 0)
            {
                NSString* soundVolumeWordDesc = DESC(@"gameoptions-sound-volume");
                NSString* v1_string = @"|||||||||||||||||||||||||";
                NSString* v0_string = @".........................";
                v1_string = [v1_string substringToIndex:vol];
                v0_string = [v0_string substringToIndex:20 - vol];
                [gui setText:[NSString stringWithFormat:@"%@%@%@ ", soundVolumeWordDesc, v1_string, v0_string]
                      forRow:GUI_ROW(GAME,VOLUME)
                       align:GUI_ALIGN_CENTER];
            }
            else
                [gui setText:DESC(@"gameoptions-sound-volume-mute") forRow:GUI_ROW(GAME,VOLUME)  align:GUI_ALIGN_CENTER];
            timeLastKeyPress = script_time;
        }
        volumeControlPressed = YES;
    }
    else
        volumeControlPressed = NO;
 
    if ((guiSelectedRow == GUI_ROW(GAME,FOV))
        &&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left])))
    {
        if (!fovControlPressed ||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
        {
            BOOL rightKeyDown = [self checkKeyPress:n_key_gui_arrow_right];
            BOOL leftKeyDown = [self checkKeyPress:n_key_gui_arrow_left];
            float fov = [gameView fov:NO];
            float fovStep = (MAX_FOV_DEG - MIN_FOV_DEG) / 20.0f;
            fov += (((rightKeyDown && (fov < MAX_FOV_DEG)) ?
                        fovStep : 0.0f) - ((leftKeyDown && (fov > MIN_FOV_DEG)) ? fovStep : 0.0f));
            if (fov > MAX_FOV_DEG) fov = MAX_FOV_DEG;
            if (fov < MIN_FOV_DEG) fov = MIN_FOV_DEG;
            [gameView setFov:fov fromFraction:NO];
            fieldOfView = [gameView fov:YES];
            int fovTicks = (int)((fov - MIN_FOV_DEG) / fovStep);
            NSString* fovWordDesc = DESC(@"gameoptions-fov-value");
            NSString* v1_string = @"|||||||||||||||||||||||||";
            NSString* v0_string = @".........................";
            v1_string = [v1_string substringToIndex:fovTicks];
            v0_string = [v0_string substringToIndex:20 - fovTicks];
            [gui setText:[NSString stringWithFormat:@"%@%@%@ (%d%c) ", fovWordDesc, v1_string, v0_string, (int)fov, 176 /*176 is the degrees symbol ASCII code*/]   forRow:GUI_ROW(GAME,FOV)  align:GUI_ALIGN_CENTER];
            [[NSUserDefaults standardUserDefaults] setFloat:[gameView fov:NO] forKey:@"fov-value"];
            timeLastKeyPress = script_time;
        }
        fovControlPressed = YES;
    }
    else
        fovControlPressed = NO;
 
    
    // color blind mode
    if ((guiSelectedRow == GUI_ROW(GAME,COLORBLINDMODE))&&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left])))
    {
        if (!colorblindModeControlPressed)
        {
            int colorblindMode = [UNIVERSE colorblindMode];
            if ([self checkKeyPress:n_key_gui_arrow_right])
            {
                [UNIVERSE setCurrentPostFX:[UNIVERSE nextColorblindMode:colorblindMode]];
            }
            else
            {
                [UNIVERSE setCurrentPostFX:[UNIVERSE prevColorblindMode:colorblindMode]];
            }
            colorblindMode = [UNIVERSE colorblindMode]; // get the updated value
            NSString *colorblindModeDesc = [[[UNIVERSE descriptions] oo_arrayForKey: @"colorblind_mode"] oo_stringAtIndex:[UNIVERSE useShaders] ? colorblindMode : 0];
            NSString *colorblindModeMsg = OOExpandKey(@"gameoptions-colorblind-mode", colorblindModeDesc);
            [gui setText:colorblindModeMsg forRow:GUI_ROW(GAME,COLORBLINDMODE) align:GUI_ALIGN_CENTER];
        }
        colorblindModeControlPressed = YES;
    }
    else
        colorblindModeControlPressed = NO;
    
    
    if (![gameView hdrOutput])
    {
        if ((guiSelectedRow == GUI_ROW(GAME,WIREFRAMEGRAPHICS))&&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left])))
        {
            if ([self checkKeyPress:n_key_gui_arrow_right] != [UNIVERSE wireframeGraphics])
                [self playChangedOption];
            [UNIVERSE setWireframeGraphics:[self checkKeyPress:n_key_gui_arrow_right]];
            if ([UNIVERSE wireframeGraphics])
                [gui setText:DESC(@"gameoptions-wireframe-graphics-yes")  forRow:GUI_ROW(GAME,WIREFRAMEGRAPHICS)  align:GUI_ALIGN_CENTER];
            else
                [gui setText:DESC(@"gameoptions-wireframe-graphics-no")  forRow:GUI_ROW(GAME,WIREFRAMEGRAPHICS)  align:GUI_ALIGN_CENTER];
        }
    }
#if OOLITE_WINDOWS
    else
    {
        if ((guiSelectedRow == GUI_ROW(GAME,HDRPAPERWHITE))
        &&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left])))
        {
            if (!hdrPaperWhiteControlPressed)
            {
                BOOL rightKeyDown = [self checkKeyPress:n_key_gui_arrow_right];
                BOOL leftKeyDown = [self checkKeyPress:n_key_gui_arrow_left];
                float paperWhite = [gameView hdrPaperWhiteBrightness];
                paperWhite += (((rightKeyDown && (paperWhite < MAX_HDR_PAPERWHITE)) ? 10.0f : 0.0f) - ((leftKeyDown && (paperWhite > MIN_HDR_PAPERWHITE)) ? 10.0f : 0.0f));
                if (paperWhite > MAX_HDR_PAPERWHITE) paperWhite = MAX_HDR_PAPERWHITE;
                if (paperWhite < MIN_HDR_PAPERWHITE) paperWhite = MIN_HDR_PAPERWHITE;
                [gameView setHDRPaperWhiteBrightness:paperWhite];
                int paperWhiteNorm = (int)((paperWhite - MIN_HDR_PAPERWHITE) * 20 / (MAX_HDR_PAPERWHITE - MIN_HDR_PAPERWHITE));
                NSString* paperWhiteWordDesc = DESC(@"gameoptions-hdr-paperwhite");
                NSString* v1_string = @"|||||||||||||||||||||||||";
                NSString* v0_string = @".........................";
                v1_string = [v1_string substringToIndex:paperWhiteNorm];
                v0_string = [v0_string substringToIndex:20 - paperWhiteNorm];
                [gui setText:[NSString stringWithFormat:@"%@%@%@ (%d) ", paperWhiteWordDesc, v1_string, v0_string, (int)paperWhite] forRow:GUI_ROW(GAME,HDRPAPERWHITE)  align:GUI_ALIGN_CENTER];
            }
            hdrPaperWhiteControlPressed = YES;
        }
        else
            hdrPaperWhiteControlPressed = NO;
    }
#endif
    
#if !NEW_PLANETS
    if ((guiSelectedRow == GUI_ROW(GAME,PROCEDURALLYTEXTUREDPLANETS))&&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left])))
    {
        if ([self checkKeyPress:n_key_gui_arrow_right] != [UNIVERSE doProcedurallyTexturedPlanets])
        {
            [UNIVERSE setDoProcedurallyTexturedPlanets:[self checkKeyPress:n_key_gui_arrow_right]];
            [self playChangedOption];
            if ([UNIVERSE planet])
            {
                [UNIVERSE setUpPlanet];
            }
        }
        if ([UNIVERSE doProcedurallyTexturedPlanets])
            [gui setText:DESC(@"gameoptions-procedurally-textured-planets-yes")  forRow:GUI_ROW(GAME,PROCEDURALLYTEXTUREDPLANETS)  align:GUI_ALIGN_CENTER];
        else
            [gui setText:DESC(@"gameoptions-procedurally-textured-planets-no")  forRow:GUI_ROW(GAME,PROCEDURALLYTEXTUREDPLANETS)  align:GUI_ALIGN_CENTER];
    }
#endif
    
    if (guiSelectedRow == GUI_ROW(GAME,SHADEREFFECTS) && ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_arrow_left]))
    {
        if (!shaderSelectKeyPressed || (script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
        {
            int direction = ([self checkKeyPress:n_key_gui_arrow_right]) ? 1 : -1;
 
            /* (Getafix - 2015/05/07)
            Fix bug coincidentally resulting in Graphics Detail value cycling 
            when left arrow is pressed.
            
            OOGraphicsDetail is an enum type and as such it will never go 
            negative. The following code adjusts "direction" to avoid illegal
            detailLevel values.
            
            Perhaps a more elegant solution could be set in place, restructuring 
            in Universe.m the logic behing setDetailLevelDirectly and 
            setDetailLevel, not forgetting to consider Graphic Detail assigned 
            from various sources (i.e. menu, user prefs file, javascript, etc.). 
            This is postponed in order not to risk the recently announced 
            plans for v1.82 release.
            
            Generally we should decide whether the menu values should cycle or 
            not and apply it for all menu entries.
            */ 
            if ((([UNIVERSE detailLevel] == DETAIL_LEVEL_MINIMUM) && (direction == -1)) || 
                    (([UNIVERSE detailLevel] == DETAIL_LEVEL_MAXIMUM) && (direction == 1)))
                direction = 0;
            
            OOGraphicsDetail detailLevel = [UNIVERSE detailLevel] + direction;
            [UNIVERSE setDetailLevel:detailLevel];
            detailLevel = [UNIVERSE detailLevel];
 
            NSString *shaderEffectsOptionsString = OOExpand(@"gameoptions-detaillevel-[detailLevel]", detailLevel);
            [gui setText:OOExpandKey(shaderEffectsOptionsString) forRow:GUI_ROW(GAME,SHADEREFFECTS) align:GUI_ALIGN_CENTER];
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,SHADEREFFECTS)];
 
            timeLastKeyPress = script_time;
            
            // changing detail level may result in changes to other settings too
            // (e.g. colorblind mode status), so refresh the page
            [self setGuiToGameOptionsScreen];
            [gui setSelectedRow:GUI_ROW(GAME,SHADEREFFECTS)];
        }
        shaderSelectKeyPressed = YES;
    }
    else shaderSelectKeyPressed = NO;
    
#if OOLITE_SDL
    if ((guiSelectedRow == GUI_ROW(GAME,DISPLAYSTYLE)) && selectKeyPress)
    {
        [gameView toggleScreenMode];
        // redraw GUI
        [self setGuiToGameOptionsScreen];
    }
#endif
 
    if ((guiSelectedRow == GUI_ROW(GAME,DOCKINGCLEARANCE))&&(([self checkKeyPress:n_key_gui_arrow_right])||([self checkKeyPress:n_key_gui_arrow_left])))
    {
        if ([self checkKeyPress:n_key_gui_arrow_right] != [UNIVERSE dockingClearanceProtocolActive])
            [self playChangedOption];
        [UNIVERSE setDockingClearanceProtocolActive:[self checkKeyPress:n_key_gui_arrow_right]];
        if ([UNIVERSE dockingClearanceProtocolActive])
            [gui setText:DESC(@"gameoptions-docking-clearance-yes")  forRow:GUI_ROW(GAME,DOCKINGCLEARANCE)  align:GUI_ALIGN_CENTER];
        else
            [gui setText:DESC(@"gameoptions-docking-clearance-no")  forRow:GUI_ROW(GAME,DOCKINGCLEARANCE)  align:GUI_ALIGN_CENTER];
    }
    
    if ((guiSelectedRow == GUI_ROW(GAME,BACK)) && selectKeyPress)
    {
        [gameView clearKeys];
        [self setGuiToLoadSaveScreen];
    }
}

handleGUIUpDownArrowKeys

- (BOOL) handleGUIUpDownArrowKeys

Provided by category PlayerEntity(Controls).

Definition at line 164 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;
}

handleKeyboardLayoutEntryKeys:view:

- (void) handleKeyboardLayoutEntryKeys:		(GuiDisplayGen *)	gui
view:		(MyOpenGLView *)	gameView

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                      :(GuiDisplayGen *)gui view:(MyOpenGLView *)gameView
{
    [self handleGUIUpDownArrowKeys];
    BOOL selectKeyPress = ([self checkKeyPress:n_key_gui_select] || [gameView isDown:gvMouseDoubleClick]);
    if ([gameView isDown:gvMouseDoubleClick])  [gameView clearMouse];
 
    NSString *key = [gui keyForRow: [gui selectedRow]];
    if (selectKeyPress)
    {
        if ([key hasPrefix:@"More:"])
        {
            int from_function = [[[key componentsSeparatedByString:@":"] objectAtIndex:1] intValue];
            if (from_function < 0)  from_function = 0;
 
            current_row = GUI_ROW_KC_FUNCSTART;
            if (from_function == 0) current_row = GUI_ROW_KC_FUNCSTART + MAX_ROWS_KC_FUNCTIONS - 1;
            [self setGuiToKeyboardLayoutScreen:from_function];
            if ([gameView isDown:gvMouseDoubleClick]) [gameView clearMouse];
            return;
        }
 
        // update the keyboard code
        NSUInteger idx =[[[key componentsSeparatedByString:@":"] objectAtIndex:1] intValue];
        NSString *kbd = [[kbdLayouts objectAtIndex:idx] objectForKey:@"key"];
        NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
        [defaults setObject:kbd forKey:@"keyboard-code"];
        [self initKeyConfigSettings];
        [self initCheckingDictionary];
 
        [gameView clearKeys];   // try to stop key bounces
        [self setGuiToKeyMapperScreen:0 resetCurrentRow:YES];
    }
    if ([gameView isDown:27]) // escape - return without change
    {
        [gameView clearKeys];   // try to stop key bounces
        [self setGuiToKeyMapperScreen:0 resetCurrentRow:YES];
    }   
}

handleKeyboardLayoutKeys

- (void) handleKeyboardLayoutKeys

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
    
    [self handleKeyboardLayoutEntryKeys: gui view: gameView];
    leftRightKeyPressed = [self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up] || [self checkKeyPress:n_key_gui_page_down];
    if (leftRightKeyPressed)
    {
        NSString *key = [gui keyForRow: [gui selectedRow]];
        if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down])
        {
            key = [gui keyForRow:GUI_ROW_KC_FUNCEND];
        }
        if ([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up])
        {
            key = [gui keyForRow:GUI_ROW_KC_FUNCSTART];
        }
        int from_function = 0;
        NSArray *keyComponents = [key componentsSeparatedByString:@":"];
        if ([keyComponents count] > 1)
        {
            from_function = [keyComponents oo_intAtIndex:1];
            if (from_function < 0)  from_function = 0;
            
            [self setGuiToKeyboardLayoutScreen:from_function resetCurrentRow:YES];
            if ([[UNIVERSE gui] selectedRow] < GUI_ROW_KC_FUNCSTART)
            {
                [[UNIVERSE gui] setSelectedRow: GUI_ROW_KC_FUNCSTART];
            }
            if (from_function == 0)
            {
                [[UNIVERSE gui] setSelectedRow: GUI_ROW_KC_FUNCSTART + MAX_ROWS_KC_FUNCTIONS - 1];
            }
        }
    }
}

handleKeyConfigEntryKeys:view:

- (void) handleKeyConfigEntryKeys:		(GuiDisplayGen *)	gui
view:		(MyOpenGLView *)	gameView

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                 :(GuiDisplayGen *)gui view:(MyOpenGLView *)gameView
{
    NSUInteger end_row = 21;
    if ([[self hud] allowBigGui]) 
    {
        end_row = 27;
    }
 
    [self handleGUIUpDownArrowKeys];
    if ([gameView lastKeyWasShifted]) last_shift = YES;
 
    [gui setText:
        [NSString stringWithFormat:DESC(@"Key: %@"), [gameView typedString]]
          forRow: end_row];
    [gui setColor:[OOColor cyanColor] forRow:end_row];
 
    if ([self checkKeyPress:n_key_gui_select]) 
    {
        [gameView suppressKeysUntilKeyUp];
        // update function key
        [self updateKeyDefinition:[gameView typedString] index:key_index];
        [gameView clearKeys];   // try to stop key bounces
        [self setGuiToKeyConfigScreen:YES];
    }
    if ([gameView isDown:27]) // escape
    {
        [gameView suppressKeysUntilKeyUp];
        // don't update function key
        [self setGuiToKeyConfigScreen:YES];
    }
}

handleKeyConfigKeys:view:

- (void) handleKeyConfigKeys:		(GuiDisplayGen *)	gui
view:		(MyOpenGLView *)	gameView

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                            :(GuiDisplayGen *)gui view:(MyOpenGLView *)gameView
{
    [self handleGUIUpDownArrowKeys];
    BOOL selectKeyPress = ([self checkKeyPress:n_key_gui_select]||[gameView isDown:gvMouseDoubleClick]);
    if ([gameView isDown:gvMouseDoubleClick])  [gameView clearMouse];
    
    if (selectKeyPress && ([gui selectedRow] == GUI_ROW_KC_KEY || [gui selectedRow] == (GUI_ROW_KC_KEY + 5)))
    {
        key_index = ([gui selectedRow] == GUI_ROW_KC_KEY ? 0 : 1);
        [self setGuiToKeyConfigEntryScreen];
    }
 
    if (selectKeyPress && ([gui selectedRow] == GUI_ROW_KC_SHIFT || [gui selectedRow] == (GUI_ROW_KC_SHIFT + 5)))
    {
        [self updateShiftKeyDefinition:@"shift" index:([gui selectedRow] == GUI_ROW_KC_SHIFT ? 0 : 1)];
        [self setGuiToKeyConfigScreen];
    }
    if (selectKeyPress && ([gui selectedRow] == GUI_ROW_KC_MOD1 || [gui selectedRow] == (GUI_ROW_KC_MOD1 + 5)))
    {
        [self updateShiftKeyDefinition:@"mod1" index:([gui selectedRow] == GUI_ROW_KC_MOD1 ? 0 : 1)];
        [self setGuiToKeyConfigScreen];
    }
    if (selectKeyPress && ([gui selectedRow] == GUI_ROW_KC_MOD2 || [gui selectedRow] == (GUI_ROW_KC_MOD2 + 5)))
    {
        [self updateShiftKeyDefinition:@"mod2" index:([gui selectedRow] == GUI_ROW_KC_MOD2 ? 0 : 1)];
        [self setGuiToKeyConfigScreen];
    }
 
    if (selectKeyPress && [gui selectedRow] == GUI_ROW_KC_SAVE)
    {
        [self saveKeySetting:[selected_entry objectForKey: KEY_KC_DEFINITION]];
        [self reloadPage];
    }
 
    if ((selectKeyPress && [gui selectedRow] == GUI_ROW_KC_CANCEL) || [gameView isDown:27])
    {
        // esc or Cancel was pressed - get out of here
        [self reloadPage];
    }
}

handleKeyMapperConfirmClearKeys:view:

- (void) handleKeyMapperConfirmClearKeys:		(GuiDisplayGen *)	gui
view:		(MyOpenGLView *)	gameView

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                        :(GuiDisplayGen *)gui view:(MyOpenGLView *)gameView
{
    [self handleGUIUpDownArrowKeys];
 
    BOOL selectKeyPress = ([self checkKeyPress:n_key_gui_select]||[gameView isDown:gvMouseDoubleClick]);
    if ([gameView isDown:gvMouseDoubleClick]) [gameView clearMouse];
 
    // 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 ((selectKeyPress && ([gui selectedRow] == GUI_ROW_KC_CONFIRMCLEAR_YES))||[gameView isDown:cYes]||[gameView isDown:cYes - 32])
    {
        [self deleteAllKeySettings];
        [gameView suppressKeysUntilKeyUp];
        [self setGuiToKeyMapperScreen:0 resetCurrentRow:YES];
    }
    
    if ((selectKeyPress && ([gui selectedRow] == GUI_ROW_KC_CONFIRMCLEAR_NO))||[gameView isDown:27]||[gameView isDown:cNo]||[gameView isDown:cNo - 32])
    {
        // esc or NO was pressed - get out of here
        [gameView suppressKeysUntilKeyUp];
        [self setGuiToKeyMapperScreen:0 resetCurrentRow:YES];
    }
}

handleKeyMapperScreenKeys

- (void) handleKeyMapperScreenKeys

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
 
    [self keyMapperInputHandler: gui view: gameView];
    leftRightKeyPressed = [self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up] || [self checkKeyPress:n_key_gui_page_down];
    if (leftRightKeyPressed)
    {
        NSString *key = [gui keyForRow: [gui selectedRow]];
        if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down])
        {
            key = [gui keyForRow:GUI_ROW_KC_FUNCEND];
        }
        if ([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up])
        {
            key = [gui keyForRow:GUI_ROW_KC_FUNCSTART];
        }
        int from_function = 0;
        NSArray *keyComponents = [key componentsSeparatedByString:@":"];
        if ([keyComponents count] > 1)
        {
            from_function = [keyComponents oo_intAtIndex:1];
            if (from_function < 0)  from_function = 0;
            
            [self setGuiToKeyMapperScreen:from_function resetCurrentRow: YES];
            if ([[UNIVERSE gui] selectedRow] < GUI_ROW_KC_FUNCSTART)
            {
                [[UNIVERSE gui] setSelectedRow: GUI_ROW_KC_FUNCSTART];
            }
            if (from_function == 0)
            {
                [[UNIVERSE gui] setSelectedRow: GUI_ROW_KC_FUNCSTART + MAX_ROWS_KC_FUNCTIONS - 1];
            }
        }
    }
}

handleMissionCallback

- (void) handleMissionCallback

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

{
    [UNIVERSE removeDemoShips];
    [[UNIVERSE gui] clearBackground];
 
    [self setGuiToMissionEndScreen]; // need this to find out if we call a new mission screen inside callback.
    
    if ([self status] != STATUS_DOCKED) [self switchToThisView:VIEW_FORWARD];
 
    if (_missionWithCallback)
    {
        [self doMissionCallback];
    }
    
    if ([self status] != STATUS_DOCKED) // did we launch inside callback? / are we in flight?
    {
        // TODO: This is no longer doing anything because of an 'isDocked' check inside the function. ***** Probably remove it for 1.76
        [self doWorldEventUntilMissionScreen:OOJSID("missionScreenEnded")]; // no opportunity events.
    }
    else
    {
        if (gui_screen != GUI_SCREEN_MISSION) // did we call a new mission screen inside callback?
        {
            // note that this might not be the same end screen as last time...
            [self setGuiToMissionEndScreen];    // if not, update status screen with callback changes, if any.
            [self endMissionScreenAndNoteOpportunity];  // missionScreenEnded, plus opportunity events.
        }
    }
}

handleStickMapperScreenKeys

- (void) handleStickMapperScreenKeys

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
    
    [self stickMapperInputHandler: gui view: gameView];
    leftRightKeyPressed = [self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up] || [self checkKeyPress:n_key_gui_page_down];
    if (leftRightKeyPressed)
    {
        NSString *key = [gui keyForRow: [gui selectedRow]];
        if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down])
        {
            key = [gui keyForRow:GUI_ROW_FUNCEND];
        }
        if ([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up])
        {
            key = [gui keyForRow:GUI_ROW_FUNCSTART];
        }
        int from_function = 0;
        NSArray *keyComponents = [key componentsSeparatedByString:@":"];
        if ([keyComponents count] > 1)
        {
            from_function = [keyComponents oo_intAtIndex:1];
            if (from_function < 0)  from_function = 0;
            
            [self setGuiToStickMapperScreen:from_function resetCurrentRow: YES];
            if ([[UNIVERSE gui] selectedRow] < GUI_ROW_FUNCSTART)
            {
                [[UNIVERSE gui] setSelectedRow: GUI_ROW_FUNCSTART];
            }
            if (from_function == 0)
            {
                [[UNIVERSE gui] setSelectedRow: GUI_ROW_FUNCSTART + MAX_ROWS_FUNCTIONS - 1];
            }
        }
    }
    if([gameView isDown:' '])  [self setGuiToGameOptionsScreen];
}

handleUndockControl

- (void) handleUndockControl

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

{
    // FIXME: should this not be in leaveDock:? (Note: leaveDock: is also called from script method launchFromStation and -[StationEntity becomeExplosion]) -- Ahruman 20080308
    [UNIVERSE setUpUniverseFromStation]; // player pre-launch
    if ([self dockedStation] == nil)  [self setDockedAtMainStation];
    
    StationEntity *dockedStation = [self dockedStation];
    if (dockedStation == [UNIVERSE station] && [UNIVERSE autoSaveNow] && !([[UNIVERSE sun] goneNova] || [[UNIVERSE sun] willGoNova]))
    {
        [self autosavePlayer];
    }
    [self launchFromStation];
}

hasHostileTarget

- (BOOL) hasHostileTarget

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

{
    ShipEntity *playersTarget = [self primaryTarget];
    return ([playersTarget isShip] && [playersTarget hasHostileTarget] && [playersTarget primaryTarget] == self);
}

hasOneEquipmentItem:includeMissiles:

- (BOOL) hasOneEquipmentItem: (NSString *)  itemKey includeMissiles: (BOOL)  includeMissiles

implementation

Definition at line 9242 of file PlayerEntity.m.

                            :(NSString *)itemKey includeMissiles:(BOOL)includeMissiles
{
    // Check basic equipment the normal way.
    if ([super hasOneEquipmentItem:itemKey includeMissiles:NO whileLoading:NO])  return YES;
    
    // Custom handling for player missiles.
    if (includeMissiles)
    {
        unsigned i;
        for (i = 0; i < max_missiles; i++)
        {
            if ([[self missileForPylon:i] hasPrimaryRole:itemKey])  return YES;
        }
    }
    
    if ([itemKey isEqualToString:@"EQ_TRUMBLE"])
    {
        return [self trumbleCount] > 0;
    }
    
    return NO;
}

hasPrimaryWeapon:

- (BOOL) hasPrimaryWeapon: (OOWeaponType)  weaponType

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                         :(OOWeaponType)weaponType
{
    if ([[forward_weapon_type identifier] isEqualToString:[weaponType identifier]] ||
        [[aft_weapon_type identifier] isEqualToString:[weaponType identifier]] ||
        [[port_weapon_type identifier] isEqualToString:[weaponType identifier]] ||
        [[starboard_weapon_type identifier] isEqualToString:[weaponType identifier]])
    {
        return YES;
    }
    
    return [super hasPrimaryWeapon:weaponType];
}

hasSufficientFuelForJump

- (BOOL) hasSufficientFuelForJump

Definition at line 13727 of file PlayerEntity.m.

{
    return fuel >= [self fuelRequiredForJump];
}

highlightEquipShipScreenKey:

- (void) highlightEquipShipScreenKey:

(NSString *)

key

Definition at line 9242 of file PlayerEntity.m.

                                    :(NSString *)key
{
    int             i=0;
    OOGUIRow        row;
    NSString        *otherKey = @"";
    GuiDisplayGen   *gui = [UNIVERSE gui];
    [last_outfitting_key release];
    last_outfitting_key = [key copy];
    [self setGuiToEquipShipScreen:-1];
    key = last_outfitting_key;
    // TODO: redo the equipShipScreen in a way that isn't broken. this whole method 'works'
    // based on the way setGuiToEquipShipScreen  'worked' on 20090913 - Kaks 
    
    // setGuiToEquipShipScreen doesn't take a page number, it takes an offset from the beginning
    // of the dictionary, the first line will show the key at that offset...
    
    // try the last page first - 10 pages max.
    while (otherKey)
    {
        [self setGuiToEquipShipScreen:i];
        for (row = GUI_ROW_EQUIPMENT_START;row<=GUI_MAX_ROWS_EQUIPMENT+2;row++)
        {
            otherKey = [gui keyForRow:row];
            if (!otherKey)
            {
                [self setGuiToEquipShipScreen:0];
                return;
            }
            if ([otherKey isEqualToString:key])
            {
                [gui setSelectedRow:row];
                [self showInformationForSelectedUpgrade];
                return;
            }
        }
        if ([otherKey hasPrefix:@"More:"])
        {
            i = [[otherKey componentsSeparatedByString:@":"] oo_intAtIndex:1];
        }
        else
        {
            [self setGuiToEquipShipScreen:0];
            return;
        }
    }
}

homeInfoSystem

- (void) homeInfoSystem

Definition at line 13727 of file PlayerEntity.m.

{
    [self setInfoSystemID: system_id moveChart: YES];
    return;
}

hud

- (HeadUpDisplay *) hud

hwToString:

- (NSString *) hwToString: (int)  hwFlags

implementation

Provided by category PlayerEntity(StickMapperInternal).

Definition at line 1 of file PlayerEntityStickMapper.m.

                        : (int)hwFlags
{
    NSString *hwString;
    switch(hwFlags)
    {
        case HW_AXIS:
            hwString = @"axis";
            break;
        case HW_BUTTON:
            hwString = @"button";
            break;
        default:
            hwString = @"axis/button";
    }
    return hwString;   
}

hyperspaceJumpDistance

- (double) hyperspaceJumpDistance

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    NSPoint targetCoordinates = PointFromString([[UNIVERSE systemManager] getProperty:@"coordinates" forSystem:[self nextHopTargetSystemID] inGalaxy:galaxy_number]);
    return distanceBetweenPlanetPositions(targetCoordinates.x,targetCoordinates.y,galaxy_coordinates.x,galaxy_coordinates.y);
}

hyperspeedEngaged

- (BOOL) hyperspeedEngaged

Definition at line 13727 of file PlayerEntity.m.

{
    return hyperspeed_engaged;
}

hyperspeedFactor

- (GLfloat) hyperspeedFactor

increaseContractReputation:

- (void) increaseContractReputation:

(unsigned)

amount

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                                   :(unsigned)amount
{
    int good = [reputation oo_intForKey:CONTRACTS_GOOD_KEY];
    int bad = [reputation oo_intForKey:CONTRACTS_BAD_KEY];
    int unknown = [reputation oo_intForKey:CONTRACTS_UNKNOWN_KEY];
    
    for (unsigned i=0;i<amount;i++)
    {
    if (bad > 0)
    {
        // shift a bean from bad to unknown
        bad--;
        if (unknown < MAX_CONTRACT_REP)
            unknown++;
    }
    else
    {
        // shift a bean from unknown to good
        if (unknown > 0)
            unknown--;
        if (good < MAX_CONTRACT_REP)
            good++;
    }
    }
    [reputation oo_setInteger:good      forKey:CONTRACTS_GOOD_KEY];
    [reputation oo_setInteger:bad       forKey:CONTRACTS_BAD_KEY];
    [reputation oo_setInteger:unknown   forKey:CONTRACTS_UNKNOWN_KEY];
}

increaseParcelReputation:

- (void) increaseParcelReputation:

(unsigned)

amount

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                                 :(unsigned)amount
{
    int good = [reputation oo_intForKey:PARCEL_GOOD_KEY];
    int bad = [reputation oo_intForKey:PARCEL_BAD_KEY];
    int unknown = [reputation oo_intForKey:PARCEL_UNKNOWN_KEY];
 
        for (unsigned i=0;i<amount;i++)
    {
    if (bad > 0)
    {
        // shift a bean from bad to unknown
        bad--;
        if (unknown < MAX_CONTRACT_REP)
            unknown++;
    }
    else
    {
        // shift a bean from unknown to good
        if (unknown > 0)
            unknown--;
        if (good < MAX_CONTRACT_REP)
            good++;
    }
    }
    [reputation oo_setInteger:good      forKey:PARCEL_GOOD_KEY];
    [reputation oo_setInteger:bad       forKey:PARCEL_BAD_KEY];
    [reputation oo_setInteger:unknown   forKey:PARCEL_UNKNOWN_KEY];
}

increasePassengerReputation:

- (void) increasePassengerReputation:

(unsigned)

amount

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                                    :(unsigned)amount
{
    int good = [reputation oo_intForKey:PASSAGE_GOOD_KEY];
    int bad = [reputation oo_intForKey:PASSAGE_BAD_KEY];
    int unknown = [reputation oo_intForKey:PASSAGE_UNKNOWN_KEY];
    
    for (unsigned i=0;i<amount;i++)
    {
    if (bad > 0)
    {
        // shift a bean from bad to unknown
        bad--;
        if (unknown < MAX_CONTRACT_REP)
            unknown++;
    }
    else
    {
        // shift a bean from unknown to good
        if (unknown > 0)
            unknown--;
        if (good < MAX_CONTRACT_REP)
            good++;
    }
    }
    [reputation oo_setInteger:good      forKey:PASSAGE_GOOD_KEY];
    [reputation oo_setInteger:bad       forKey:PASSAGE_BAD_KEY];
    [reputation oo_setInteger:unknown   forKey:PASSAGE_UNKNOWN_KEY];
}

increment:

- (void) increment:

(NSString *)

missionVariableString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *)missionVariableString
{
    BOOL hasMissionPrefix, hasLocalPrefix;
    int value = 0;
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
 
    if (hasMissionPrefix)
    {
        value = [[self missionVariableForKey:missionVariableString] intValue];
        value++;
        [self setMissionVariable:[NSString stringWithFormat:@"%d", value] forKey:missionVariableString];
    }
    else if (hasLocalPrefix)
    {
        value = [[self localVariableForKey:missionVariableString andMission:sCurrentMissionKey] intValue];
        value++;
        [self setLocalVariable:[NSString stringWithFormat:@"%d", value] forKey:missionVariableString andMission:sCurrentMissionKey];
    }
    else
    {
        OOLog(kOOLogSyntaxIncrement, @"***** SCRIPT ERROR: in %@, IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString);
    }
}

infoSystemID

- (OOSystemID) infoSystemID

Definition at line 13727 of file PlayerEntity.m.

{
    return info_system_id;
}

infoSystemOnRoute

- (BOOL) infoSystemOnRoute

Definition at line 13727 of file PlayerEntity.m.

{
    NSArray *route = [[UNIVERSE routeFromSystem:system_id toSystem:target_system_id optimizedBy:ANA_mode] oo_arrayForKey: @"route"];
    NSUInteger i;
    if (route == nil)
    {
        return NO;
    }
    for (i = 0; i < [route count]; i++)
    {
        if ([[route objectAtIndex: i] intValue] == info_system_id)
        {
            return YES;
        }
    }
    return NO;
}

init

- (id) init

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    NSAssert(gOOPlayer == nil, @"Expected only one PlayerEntity to exist at a time.");
    return [super initBypassForPlayer];
}

initCheckingDictionary

- (void) initCheckingDictionary

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.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 *kdic = [NSMutableDictionary dictionaryWithDictionary:[kdicmaster objectForKey:kbd]];
 
    NSUInteger i;
    NSArray *keys = nil;
    id key = nil;
    NSArray *def_list = nil;
 
    keys = [kdic allKeys];
    for (i = 0; i < [keys count]; i++)
    {
        key = [keys objectAtIndex:i];
 
        if ([[kdic objectForKey: key] isKindOfClass:[NSArray class]])
        {
            def_list = (NSArray*)[kdic objectForKey: key];
            [kdic setObject:[self processKeyCode:def_list] forKey:key];
        }
    }
    [kdic_check release];
    kdic_check = [[NSDictionary alloc] initWithDictionary:kdic];
 
    // these keys can't be used with mod keys
    [nav_keys release];
    nav_keys = [[NSArray alloc] initWithObjects:@"key_roll_left", @"key_roll_right", @"key_pitch_forward", @"key_pitch_back", @"key_yaw_left", @"key_yaw_right", 
        @"key_fire_lasers", @"key_gui_arrow_up", @"key_gui_arrow_down", @"key_gui_arrow_right", @"key_gui_arrow_left", nil];
    // these keys can't be used with ctrl
    [camera_keys release];
    camera_keys = [[NSArray alloc] initWithObjects:@"key_custom_view_zoom_out", @"key_custom_view_zoom_in", @"key_custom_view_roll_left", @"key_custom_view_roll_right",
        @"key_custom_view_pan_left", @"key_custom_view_pan_right", @"key_custom_view_rotate_up", @"key_custom_view_rotate_down", @"key_custom_view_pan_down",
        @"key_custom_view_pan_up", @"key_custom_view_rotate_left", @"key_custom_view_rotate_right", nil];
}

initControls

- (void) initControls

Provided by category PlayerEntity(Controls).

Definition at line 164 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;
}

initialiseMissionDestinations:andLegacy:

- (void) initialiseMissionDestinations:		(NSDictionary *)	destinations
andLegacy:		(NSArray *)	legacy

Definition at line 9242 of file PlayerEntity.m.

                                      :(NSDictionary *)destinations andLegacy:(NSArray *)legacy
{
    NSString                    *key = nil;
    id                          value = nil;
 
    /* same need to make inner objects mutable as in localPlanetInfoOverrides */
 
    [missionDestinations release];
    missionDestinations = [[NSMutableDictionary alloc] init];
 
    foreachkey (key, destinations)
    {
        value = [destinations objectForKey:key];
        if (value != nil)
        {
            if ([value isKindOfClass:[NSDictionary class]])
            {
                value = [value mutableCopy];
                [missionDestinations setObject:value forKey:key];
                [value release];
            }
        }
    }
    
    if (legacy != nil)
    {
        OOSystemID dest;
        NSNumber *legacyMarker;
        foreach (legacyMarker, legacy)
        {
            dest = [legacyMarker intValue];
            [self addMissionDestinationMarker:[self defaultMarker:dest]];
        }
    }
 
}

initKeyConfigSettings

- (void) initKeyConfigSettings

Provided by category PlayerEntity(Controls).

Definition at line 164 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];
}

injectorsEngaged

- (BOOL) injectorsEngaged

Definition at line 13727 of file PlayerEntity.m.

{
    return afterburner_engaged;
}

insideAtmosphereFraction

- (GLfloat) insideAtmosphereFraction

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat insideAtmoFrac = 0.0f;
    
    if ([UNIVERSE airResistanceFactor] > 0.01)  // player is inside planetary atmosphere
    {
        insideAtmoFrac = 1.0f - ([self dialAltitude] *  (GLfloat)PLAYER_DIAL_MAX_ALTITUDE / (10.0f * (GLfloat)ATMOSPHERE_DEPTH));
    }
    
    return insideAtmoFrac;
}

installedEnergyUnitType

- (OOEnergyUnitType) installedEnergyUnitType

Definition at line 13727 of file PlayerEntity.m.

{
    if ([self hasEquipmentItem:@"EQ_NAVAL_ENERGY_UNIT"])  return ENERGY_UNIT_NAVAL;
    if ([self hasEquipmentItem:@"EQ_ENERGY_UNIT"])  return ENERGY_UNIT_NORMAL;
    return ENERGY_UNIT_NONE;
}

interpretAIMessage:

- (void) interpretAIMessage: (NSString *)  ms

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                           :(NSString *)ms
{
    if ([ms isEqual:@"HOLD_FULL"])
    {
        [self playHoldFull];
        [UNIVERSE addMessage:DESC(@"hold-full") forCount:4.5];
    }
 
    if ([ms isEqual:@"INCOMING_MISSILE"])
    {
        if ([self primaryAggressor] != nil)
        {
            [self playIncomingMissile:HPVectorToVector([[self primaryAggressor] position])];
        }
        else
        {
            [self playIncomingMissile:kZeroVector];
        }
        [UNIVERSE addMessage:DESC(@"incoming-missile") forCount:4.5];
    }
 
    if ([ms isEqual:@"ENERGY_LOW"])
    {
        [UNIVERSE addMessage:DESC(@"energy-low") forCount:6.0];
    }
 
    if ([ms isEqual:@"ECM"] && ![self isDocked])  [self playHitByECMSound];
 
    if ([ms isEqual:@"DOCKING_REFUSED"] && [self status] == STATUS_AUTOPILOT_ENGAGED)
    {
        [self playDockingDenied];
        [UNIVERSE addMessage:DESC(@"autopilot-denied") forCount:4.5];
        autopilot_engaged = NO;
        [self resetAutopilotAI];
        DESTROY(_primaryTarget);
        [self setStatus:STATUS_IN_FLIGHT];
        [[OOMusicController sharedController] stopDockingMusic];
        [self doScriptEvent:OOJSID("playerDockingRefused")];
    }
 
    // aegis messages to advanced compass so in planet mode it behaves like the old compass
    if (compassMode != COMPASS_MODE_BASIC)
    {
        if ([ms isEqual:@"AEGIS_CLOSE_TO_MAIN_PLANET"]&&(compassMode == COMPASS_MODE_PLANET))
        {
            [self playAegisCloseToPlanet];
            [self setCompassMode:COMPASS_MODE_STATION];
        }
        if ([ms isEqual:@"AEGIS_IN_DOCKING_RANGE"]&&(compassMode == COMPASS_MODE_PLANET))
        {
            [self playAegisCloseToStation];
            [self setCompassMode:COMPASS_MODE_STATION];
        }
        if ([ms isEqual:@"AEGIS_NONE"]&&(compassMode == COMPASS_MODE_STATION))
        {
            [self setCompassMode:COMPASS_MODE_PLANET];
        }
    }
}

isBeeping

- (BOOL) isBeeping

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    return [sInterfaceBeepSource isPlaying];
}

isDocked

- (BOOL) isDocked

Definition at line 9242 of file PlayerEntity.m.

{
    BOOL isDockedStatus = NO;
    
    switch ([self status])
    {
        case STATUS_DOCKED:
        case STATUS_DOCKING:
        case STATUS_START_GAME:
            isDockedStatus = YES;
            break;   
            // special case - can be either docked or not, so avoid safety check below
        case STATUS_RESTART_GAME:
            return NO;
        case STATUS_EFFECT:
        case STATUS_ACTIVE:
        case STATUS_COCKPIT_DISPLAY:
        case STATUS_TEST:
        case STATUS_INACTIVE:
        case STATUS_DEAD:
        case STATUS_IN_FLIGHT:
        case STATUS_AUTOPILOT_ENGAGED:
        case STATUS_LAUNCHING:
        case STATUS_WITCHSPACE_COUNTDOWN:
        case STATUS_ENTERING_WITCHSPACE:
        case STATUS_EXITING_WITCHSPACE:
        case STATUS_ESCAPE_SEQUENCE:
        case STATUS_IN_HOLD:
        case STATUS_BEING_SCOOPED:
        case STATUS_HANDLING_ERROR:
            break;
        //no default, so that we get notified by the compiler if something is missing
    }
    
#ifndef NDEBUG
    // Sanity check
    if (isDockedStatus)
    {
        if ([self dockedStation] == nil)
        {
            //there are a number of possible current statuses, not just STATUS_DOCKED
            OOLogERR(kOOLogInconsistentState, @"status is %@, but dockedStation is nil; treating as not docked. %@", OOStringFromEntityStatus([self status]), @"This is an internal error, please report it.");
            [self setStatus:STATUS_IN_FLIGHT];
            isDockedStatus = NO;
        }
    }
    else
    {
        if ([self dockedStation] != nil && [self status] != STATUS_LAUNCHING)
        {
            OOLogERR(kOOLogInconsistentState, @"status is %@, but dockedStation is not nil; treating as docked. %@", OOStringFromEntityStatus([self status]), @"This is an internal error, please report it.");
            [self setStatus:STATUS_DOCKED];
            isDockedStatus = YES;
        }
    }
#endif
    
    return isDockedStatus;
}

isMining

- (BOOL) isMining

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

{
    return using_mining_laser;
}

isMouseControlOn

- (BOOL) isMouseControlOn

Definition at line 13727 of file PlayerEntity.m.

{
    return mouse_control_on;
}

isPlayerLikeShip

- (BOOL) isPlayerLikeShip

implementation

Reimplemented from Entity.

Provided by category PlayerEntity(ProxyPlayer).

Definition at line 1 of file ProxyPlayerEntity.m.

{
    return YES;
}

isSpeechOn

- (OOSpeechSettings) isSpeechOn

isValidTarget:

- (BOOL) isValidTarget:

(Entity*)

target

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                     :(Entity*)target
{
    // Just in case we got called with a bad target.
    if (!target)
        return NO;
 
    // If target is beyond scanner range, it's lost
    if(target->zero_distance > SCANNER_MAX_RANGE2)
        return NO;
 
    // If target is a ship, check whether it's cloaked or is actively jamming our scanner
    if ([target isShip])
    {
        ShipEntity *targetShip = (ShipEntity*)target;
        if ([targetShip isCloaked] ||   // checks for cloaked ships
            ([targetShip isJammingScanning] && ![self hasMilitaryScannerFilter]))   // checks for activated jammer
        {
            return NO;
        }
        OOEntityStatus tstatus = [targetShip status];
        if (tstatus == STATUS_ENTERING_WITCHSPACE || tstatus == STATUS_IN_HOLD || tstatus == STATUS_DOCKED)
        { // checks for ships entering wormholes, docking, or been scooped
            return NO;
        }
        return YES;
    }
 
    // If target is an unexpired wormhole and the player has bought the Wormhole Scanner and we're in ID mode
    if ([target isWormhole] && [target scanClass] != CLASS_NO_DRAW && 
        [self hasEquipmentItemProviding:@"EQ_WORMHOLE_SCANNER"] && ident_engaged)
    {
        return YES;
    }
    
    // Target is neither a wormhole nor a ship
    return NO;
}

javaScriptEngineWillReset:

- (void) javaScriptEngineWillReset: (NSNotification *)  notification

implementation

Provided by category PlayerEntity(OOJavaScriptExtensions).

Definition at line 1860 of file OOJSPlayerShip.m.

                                  :(NSNotification *)notification
{
    [[NSNotificationCenter defaultCenter] removeObserver:self
                                                    name:kOOJavaScriptEngineWillResetNotification
                                                  object:[OOJavaScriptEngine sharedEngine]];
    
    if (_jsSelf != NULL)
    {
        
        JSContext *context = OOJSAcquireContext();
        JS_RemoveObjectRoot(context, &_jsSelf);
        _jsSelf = NULL;
        OOJSRelinquishContext(context);
    }
}

jumpCause

- (NSString *) jumpCause

Definition at line 9242 of file PlayerEntity.m.

{ 
    return _jumpCause;
}

keyBindingDescription2:

- (NSString *) keyBindingDescription2:

(NSString *)

binding

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                     :(NSString *)binding
{
    if ([keyconfig2_settings objectForKey:binding] == nil)
    {
        // no such setting
        return nil;
    }
    NSArray *keyList = (NSArray*)[keyconfig2_settings objectForKey:binding];
    return [self getKeyBindingDescription:keyList];
}

Referenced by GlobalKeyBindingDescription().

Here is the caller graph for this function:

keyboardDescription:

- (NSString *) keyboardDescription: (NSString *)  kbd

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                 :(NSString *)kbd
{
    NSString *map = @"";
#if OOLITE_WINDOWS  
    map = @"keymappings_windows.plist";
#endif
#if OOLITE_LINUX
    map = @"keymappings_linux.plist";
#endif
#if OOLITE_MAC_OS_X
    map = @"keymappings_mac.plist";
#endif
    NSDictionary *kmap = [NSDictionary dictionaryWithDictionary:[ResourceManager dictionaryFromFilesNamed:map inFolder:@"Config" mergeMode:MERGE_BASIC cache:NO]];
    NSDictionary *sect = [kmap objectForKey:kbd];
    return [sect objectForKey:@"description"];
}

keyboardLayoutList

- (NSArray *) keyboardLayoutList

implementation

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

{
    NSString *map = @"";
#if OOLITE_WINDOWS  
    map = @"keymappings_windows.plist";
#endif
#if OOLITE_LINUX
    map = @"keymappings_linux.plist";
#endif
#if OOLITE_MAC_OS_X
    map = @"keymappings_mac.plist";
#endif
    NSDictionary *kmap = [NSDictionary dictionaryWithDictionary:[ResourceManager dictionaryFromFilesNamed:map inFolder:@"Config" mergeMode:MERGE_BASIC cache:NO]];
    NSMutableArray *kbdList = [NSMutableArray array];
    NSArray *keys = [kmap allKeys];
    NSUInteger i;
    NSDictionary *def = nil;
 
    for (i = 0; i < [keys count]; i++)
    {
        if (![[keys objectAtIndex:i] isEqualToString:@"default"])
        {
            [kbdList addObject:[[NSDictionary alloc] initWithObjectsAndKeys:[keys objectAtIndex:i], @"key", 
                [self keyboardDescription:[keys objectAtIndex:i]], @"description", 
                //([[keys objectAtIndex:i] isEqualToString:kbd] ? @"Current" : @""), @"selected",
                nil]];
        }
        else 
        {
            // key the "default" item separate, so we can add it at the top of the list, rather than getting it sorted
            def = [[NSDictionary alloc] initWithObjectsAndKeys:[keys objectAtIndex:i], @"key", 
                [self keyboardDescription:[keys objectAtIndex:i]], @"description", 
                //([[keys objectAtIndex:i] isEqualToString:kbd] ? @"Current" : @""), @"selected",
                nil];
        }
    }
 
    NSSortDescriptor *sortDescriptor = [[NSSortDescriptor alloc] initWithKey:@"description" ascending:YES];
    NSArray *sortDescriptors = [NSArray arrayWithObject:sortDescriptor];
    NSMutableArray *sorted = [NSMutableArray arrayWithArray:[kbdList sortedArrayUsingDescriptors:sortDescriptors]];
    [sorted insertObject:def atIndex:0];
    
    [sortDescriptor release];
 
    return sorted;
}

keyCodeDescription:

- (NSString *) keyCodeDescription:

(OOKeyCode)

code

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                 :(OOKeyCode)code
{
    switch (code)
    {
    case 0:
        return DESC(@"oolite-keycode-unset");
    case 9:
        return DESC(@"oolite-keycode-tab");
    case 13:
        return DESC(@"oolite-keycode-enter");
    case 27:
        return DESC(@"oolite-keycode-esc");
    case 32:
        return DESC(@"oolite-keycode-space");
    case gvFunctionKey1:
        return DESC(@"oolite-keycode-f1");
    case gvFunctionKey2:
        return DESC(@"oolite-keycode-f2");
    case gvFunctionKey3:
        return DESC(@"oolite-keycode-f3");
    case gvFunctionKey4:
        return DESC(@"oolite-keycode-f4");
    case gvFunctionKey5:
        return DESC(@"oolite-keycode-f5");
    case gvFunctionKey6:
        return DESC(@"oolite-keycode-f6");
    case gvFunctionKey7:
        return DESC(@"oolite-keycode-f7");
    case gvFunctionKey8:
        return DESC(@"oolite-keycode-f8");
    case gvFunctionKey9:
        return DESC(@"oolite-keycode-f9");
    case gvFunctionKey10:
        return DESC(@"oolite-keycode-f10");
    case gvFunctionKey11:
        return DESC(@"oolite-keycode-f11");
    case gvArrowKeyRight:
        return DESC(@"oolite-keycode-right");
    case gvArrowKeyLeft:
        return DESC(@"oolite-keycode-left");
    case gvArrowKeyDown:
        return DESC(@"oolite-keycode-down");
    case gvArrowKeyUp:
        return DESC(@"oolite-keycode-up");
    case gvHomeKey:
        return DESC(@"oolite-keycode-home");
    case gvEndKey:
        return DESC(@"oolite-keycode-end");
    case gvInsertKey:
        return DESC(@"oolite-keycode-insert");
    case gvDeleteKey:
        return DESC(@"oolite-keycode-delete");
    case gvPageUpKey:
        return DESC(@"oolite-keycode-pageup");
    case gvPageDownKey:
        return DESC(@"oolite-keycode-pagedown");
    case gvNumberPadKey0:
        return DESC(@"oolite-keycode-numpad0");
    case gvNumberPadKey1:
        return DESC(@"oolite-keycode-numpad1");
    case gvNumberPadKey2:
        return DESC(@"oolite-keycode-numpad2");
    case gvNumberPadKey3:
        return DESC(@"oolite-keycode-numpad3");
    case gvNumberPadKey4:
        return DESC(@"oolite-keycode-numpad4");
    case gvNumberPadKey5:
        return DESC(@"oolite-keycode-numpad5");
    case gvNumberPadKey6:
        return DESC(@"oolite-keycode-numpad6");
    case gvNumberPadKey7:
        return DESC(@"oolite-keycode-numpad7");
    case gvNumberPadKey8:
        return DESC(@"oolite-keycode-numpad8");
    case gvNumberPadKey9:
        return DESC(@"oolite-keycode-numpad9");
    case gvPrintScreenKey:
        return DESC(@"oolite-keycode-printscreen");
    case gvPauseKey:
        return DESC(@"oolite-keycode-pause");
    case gvNumberPadKeyDivide:
        return DESC(@"oolite-keycode-numpad/");
    case gvNumberPadKeyEquals:
        return DESC(@"oolite-keycode-numpad=");
    case gvNumberPadKeyMinus:
        return DESC(@"oolite-keycode-numpad-");
    case gvNumberPadKeyMultiply:
        return DESC(@"oolite-keycode-numpad*");
    case gvNumberPadKeyPeriod:
        return DESC(@"oolite-keycode-numpad.");
    case gvNumberPadKeyPlus:
        return DESC(@"oolite-keycode-numpad+");
    case gvNumberPadKeyEnter:
        return DESC(@"oolite-keycode-numpadenter");
        
    default:
        return [NSString stringWithFormat:@"%C",code];
    }
}

keyCodeDescriptionShort:

- (NSString *) keyCodeDescriptionShort:

(OOKeyCode)

code

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                      :(OOKeyCode)code
{
    switch (code)
    {
    case 0:
        return DESC(@"oolite-keycode-short-unset");
    case 9:
        return DESC(@"oolite-keycode-short-tab");
    case 13:
        return DESC(@"oolite-keycode-short-enter");
    case 27:
        return DESC(@"oolite-keycode-short-esc");
    case 32:
        return DESC(@"oolite-keycode-short-space");
    case gvFunctionKey1:
        return DESC(@"oolite-keycode-short-f1");
    case gvFunctionKey2:
        return DESC(@"oolite-keycode-short-f2");
    case gvFunctionKey3:
        return DESC(@"oolite-keycode-short-f3");
    case gvFunctionKey4:
        return DESC(@"oolite-keycode-short-f4");
    case gvFunctionKey5:
        return DESC(@"oolite-keycode-short-f5");
    case gvFunctionKey6:
        return DESC(@"oolite-keycode-short-f6");
    case gvFunctionKey7:
        return DESC(@"oolite-keycode-short-f7");
    case gvFunctionKey8:
        return DESC(@"oolite-keycode-short-f8");
    case gvFunctionKey9:
        return DESC(@"oolite-keycode-short-f9");
    case gvFunctionKey10:
        return DESC(@"oolite-keycode-short-f10");
    case gvFunctionKey11:
        return DESC(@"oolite-keycode-short-f11");
    case gvArrowKeyRight:
        return DESC(@"oolite-keycode-short-right");
    case gvArrowKeyLeft:
        return DESC(@"oolite-keycode-short-left");
    case gvArrowKeyDown:
        return DESC(@"oolite-keycode-short-down");
    case gvArrowKeyUp:
        return DESC(@"oolite-keycode-short-up");
    case gvHomeKey:
        return DESC(@"oolite-keycode-short-home");
    case gvEndKey:
        return DESC(@"oolite-keycode-short-end");
    case gvInsertKey:
        return DESC(@"oolite-keycode-short-insert");
    case gvDeleteKey:
        return DESC(@"oolite-keycode-short-delete");
    case gvPageUpKey:
        return DESC(@"oolite-keycode-short-pageup");
    case gvPageDownKey:
        return DESC(@"oolite-keycode-short-pagedown");
    case gvNumberPadKey0:
        return DESC(@"oolite-keycode-short-numpad0");
    case gvNumberPadKey1:
        return DESC(@"oolite-keycode-short-numpad1");
    case gvNumberPadKey2:
        return DESC(@"oolite-keycode-short-numpad2");
    case gvNumberPadKey3:
        return DESC(@"oolite-keycode-short-numpad3");
    case gvNumberPadKey4:
        return DESC(@"oolite-keycode-short-numpad4");
    case gvNumberPadKey5:
        return DESC(@"oolite-keycode-short-numpad5");
    case gvNumberPadKey6:
        return DESC(@"oolite-keycode-short-numpad6");
    case gvNumberPadKey7:
        return DESC(@"oolite-keycode-short-numpad7");
    case gvNumberPadKey8:
        return DESC(@"oolite-keycode-short-numpad8");
    case gvNumberPadKey9:
        return DESC(@"oolite-keycode-short-numpad9");
    case gvPrintScreenKey:
        return DESC(@"oolite-keycode-short-printscreen");
    case gvPauseKey:
        return DESC(@"oolite-keycode-short-pause");
    case gvNumberPadKeyDivide:
        return DESC(@"oolite-keycode-short-numpad/");
    case gvNumberPadKeyEquals:
        return DESC(@"oolite-keycode-short-numpad=");
    case gvNumberPadKeyMinus:
        return DESC(@"oolite-keycode-short-numpad-");
    case gvNumberPadKeyMultiply:
        return DESC(@"oolite-keycode-short-numpad*");
    case gvNumberPadKeyPeriod:
        return DESC(@"oolite-keycode-short-numpad.");
    case gvNumberPadKeyPlus:
        return DESC(@"oolite-keycode-short-numpad+");
    case gvNumberPadKeyEnter:
        return DESC(@"oolite-keycode-short-numpadenter");
    default:
        return [NSString stringWithFormat:@"%C",code];
    }
}

keyConfig

- (NSDictionary *) keyConfig

Definition at line 13727 of file PlayerEntity.m.

{
    //return keyconfig_settings;
    return keyconfig2_settings;
}

keyFunctionList

- (NSArray *) keyFunctionList

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

{
    NSMutableArray *funcList = [NSMutableArray array];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-screen-access")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_launch_ship") keyDef:@"key_launch_ship"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_screen_options") keyDef:@"key_gui_screen_options"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_screen_equipship") keyDef:@"key_gui_screen_equipship"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_screen_interfaces") keyDef:@"key_gui_screen_interfaces"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_screen_status") keyDef:@"key_gui_screen_status"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_chart_screens") keyDef:@"key_gui_chart_screens"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_system_data") keyDef:@"key_gui_system_data"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_market") keyDef:@"key_gui_market"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-propulsion")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_roll_left") keyDef:@"key_roll_left"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_roll_right") keyDef:@"key_roll_right"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_pitch_forward") keyDef:@"key_pitch_forward"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_pitch_back") keyDef:@"key_pitch_back"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_yaw_left") keyDef:@"key_yaw_left"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_yaw_right") keyDef:@"key_yaw_right"]];
 
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_increase_speed") keyDef:@"key_increase_speed"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_decrease_speed") keyDef:@"key_decrease_speed"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_inject_fuel") keyDef:@"key_inject_fuel"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_jumpdrive") keyDef:@"key_jumpdrive"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_hyperspace") keyDef:@"key_hyperspace"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_galactic_hyperspace") keyDef:@"key_galactic_hyperspace"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-navigation")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_next_compass_mode") keyDef:@"key_next_compass_mode"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_prev_compass_mode") keyDef:@"key_prev_compass_mode"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_scanner_zoom") keyDef:@"key_scanner_zoom"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_scanner_unzoom") keyDef:@"key_scanner_unzoom"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_view_forward") keyDef:@"key_view_forward"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_view_aft") keyDef:@"key_view_aft"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_view_port") keyDef:@"key_view_port"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_view_starboard") keyDef:@"key_view_starboard"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_ident_system") keyDef:@"key_ident_system"]];
 
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_docking_clearance_request") keyDef:@"key_docking_clearance_request"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_autopilot") keyDef:@"key_autopilot"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_autodock") keyDef:@"key_autodock"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_docking_music") keyDef:@"key_docking_music"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-offensive")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_weapons_online_toggle") keyDef:@"key_weapons_online_toggle"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_fire_lasers") keyDef:@"key_fire_lasers"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_launch_missile") keyDef:@"key_launch_missile"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_target_missile") keyDef:@"key_target_missile"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_untarget_missile") keyDef:@"key_untarget_missile"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_target_incoming_missile") keyDef:@"key_target_incoming_missile"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_next_missile") keyDef:@"key_next_missile"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_next_target") keyDef:@"key_next_target"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_previous_target") keyDef:@"key_previous_target"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-defensive")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_ecm") keyDef:@"key_ecm"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_dump_cargo") keyDef:@"key_dump_cargo"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_rotate_cargo") keyDef:@"key_rotate_cargo"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_launch_escapepod") keyDef:@"key_launch_escapepod"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-special-equip")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_cycle_next_mfd") keyDef:@"key_cycle_next_mfd"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_cycle_previous_mfd") keyDef:@"key_cycle_previous_mfd"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_switch_next_mfd") keyDef:@"key_switch_next_mfd"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_switch_previous_mfd") keyDef:@"key_switch_previous_mfd"]];
 
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_prime_next_equipment") keyDef:@"key_prime_next_equipment"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_prime_previous_equipment") keyDef:@"key_prime_previous_equipment"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_activate_equipment") keyDef:@"key_activate_equipment"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_mode_equipment") keyDef:@"key_mode_equipment"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_fastactivate_equipment_a") keyDef:@"key_fastactivate_equipment_a"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_fastactivate_equipment_b") keyDef:@"key_fastactivate_equipment_b"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-chart-screen")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_advanced_nav_array_next") keyDef:@"key_advanced_nav_array_next"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_advanced_nav_array_previous") keyDef:@"key_advanced_nav_array_previous"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_map_home") keyDef:@"key_map_home"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_map_end") keyDef:@"key_map_end"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_map_info") keyDef:@"key_map_info"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_map_zoom_in") keyDef:@"key_map_zoom_in"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_map_zoom_out") keyDef:@"key_map_zoom_out"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_map_next_system") keyDef:@"key_map_next_system"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_map_previous_system") keyDef:@"key_map_previous_system"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_chart_highlight") keyDef:@"key_chart_highlight"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-planet-info-screen")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_system_home") keyDef:@"key_system_home"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_system_end") keyDef:@"key_system_end"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_system_next_system") keyDef:@"key_system_next_system"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_system_previous_system") keyDef:@"key_system_previous_system"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-market-screen")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_market_filter_cycle") keyDef:@"key_market_filter_cycle"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_market_sorter_cycle") keyDef:@"key_market_sorter_cycle"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_market_buy_one") keyDef:@"key_market_buy_one"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_market_sell_one") keyDef:@"key_market_sell_one"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_market_buy_max") keyDef:@"key_market_buy_max"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_market_sell_max") keyDef:@"key_market_sell_max"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-misc")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_snapshot") keyDef:@"key_snapshot"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_pausebutton") keyDef:@"key_pausebutton"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_show_fps") keyDef:@"key_show_fps"]];
    //[funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_bloom_toggle") keyDef:@"key_bloom_toggle"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_mouse_control_roll") keyDef:@"key_mouse_control_roll"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_mouse_control_yaw") keyDef:@"key_mouse_control_yaw"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_hud_toggle") keyDef:@"key_hud_toggle"]];
#if OO_FOV_INFLIGHT_CONTROL_ENABLED
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_inc_field_of_view") keyDef:@"key_inc_field_of_view"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_dec_field_of_view") keyDef:@"key_dec_field_of_view"]];
#endif
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_comms_log") keyDef:@"key_comms_log"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-custom-view")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view") keyDef:@"key_custom_view"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_zoom_in") keyDef:@"key_custom_view_zoom_in"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_zoom_out") keyDef:@"key_custom_view_zoom_out"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_roll_left") keyDef:@"key_custom_view_roll_left"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_roll_right") keyDef:@"key_custom_view_roll_right"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_pan_left") keyDef:@"key_custom_view_pan_left"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_pan_right") keyDef:@"key_custom_view_pan_right"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_pan_up") keyDef:@"key_custom_view_pan_up"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_pan_down") keyDef:@"key_custom_view_pan_down"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_rotate_left") keyDef:@"key_custom_view_rotate_left"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_rotate_right") keyDef:@"key_custom_view_rotate_right"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_rotate_up") keyDef:@"key_custom_view_rotate_up"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_custom_view_rotate_down") keyDef:@"key_custom_view_rotate_down"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-oxz-manager")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_oxzmanager_setfilter") keyDef:@"key_oxzmanager_setfilter"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_oxzmanager_showinfo") keyDef:@"key_oxzmanager_showinfo"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_oxzmanager_extract") keyDef:@"key_oxzmanager_extract"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-gui")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_arrow_left") keyDef:@"key_gui_arrow_left"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_arrow_right") keyDef:@"key_gui_arrow_right"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_arrow_up") keyDef:@"key_gui_arrow_up"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_arrow_down") keyDef:@"key_gui_arrow_down"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_page_down") keyDef:@"key_gui_page_down"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_page_up") keyDef:@"key_gui_page_up"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_gui_select") keyDef:@"key_gui_select"]];
 
    [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-debug")]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_dump_target_state") keyDef:@"key_dump_target_state"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_dump_entity_list") keyDef:@"key_dump_entity_list"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_debug_full") keyDef:@"key_debug_full"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_debug_collision") keyDef:@"key_debug_collision"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_debug_console_connect") keyDef:@"key_debug_console_connect"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_debug_bounding_boxes") keyDef:@"key_debug_bounding_boxes"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_debug_shaders") keyDef:@"key_debug_shaders"]];
    [funcList addObject:[self makeKeyGuiDict:DESC(@"oolite-keydesc-key_debug_off") keyDef:@"key_debug_off"]];
 
    if ([customEquipActivation count] > 0) 
    {
        [funcList addObject:[self makeKeyGuiDictHeader:DESC(@"oolite-keydesc-header-oxp-equip")]];
        int i;
        for (i = 0; i < [customEquipActivation count]; i++)
        {
            [funcList addObject:[self makeKeyGuiDict:[NSString stringWithFormat: @"Activate '%@'", [[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPNAME]] 
                keyDef:[NSString stringWithFormat:@"activate_%@", [[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPKEY]]]];
            [funcList addObject:[self makeKeyGuiDict:[NSString stringWithFormat: @"Mode '%@'", [[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPNAME]] 
                keyDef:[NSString stringWithFormat:@"mode_%@", [[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPKEY]]]];
        }
    }
    return funcList;
}

keyMapperInputHandler:view:

- (void) keyMapperInputHandler:		(GuiDisplayGen *)	gui
view:		(MyOpenGLView *)	gameView

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                              :(GuiDisplayGen *)gui view:(MyOpenGLView *)gameView
{
    [self handleGUIUpDownArrowKeys];
    BOOL selectKeyPress = ([self checkKeyPress:n_key_gui_select] || [gameView isDown:gvMouseDoubleClick]);
    if ([gameView isDown:gvMouseDoubleClick])  [gameView clearMouse];
 
    NSString *key = [gui keyForRow: [gui selectedRow]];
    if ([key hasPrefix:@"Index:"])
        selFunctionIdx=[[[key componentsSeparatedByString:@":"] objectAtIndex:1] intValue];
    else
        selFunctionIdx=-1;
 
    if (selectKeyPress)
    {
        if ([key hasPrefix:@"More:"])
        {
            int from_function = [[[key componentsSeparatedByString:@":"] objectAtIndex:1] intValue];
            if (from_function < 0)  from_function = 0;
 
            current_row = GUI_ROW_KC_FUNCSTART;
            if (from_function == 0) current_row = GUI_ROW_KC_FUNCSTART + MAX_ROWS_KC_FUNCTIONS - 1;
            [self setGuiToKeyMapperScreen:from_function];
            if ([gameView isDown:gvMouseDoubleClick]) [gameView clearMouse];
            return;
        }
        if ([key hasPrefix:@"kbd:"])
        {
            [self setGuiToKeyboardLayoutScreen:0];
            if ([gameView isDown:gvMouseDoubleClick]) [gameView clearMouse];
            return;
        }
        current_row = [gui selectedRow];
        selected_entry = [keyFunctions objectAtIndex:selFunctionIdx];
        [key_list release];
        if (![self entryIsDictCustomEquip:selected_entry]) 
        {
            key_list = [[NSMutableArray alloc] initWithArray:(NSArray *)[keyconfig2_settings objectForKey:[selected_entry objectForKey:KEY_KC_DEFINITION]] copyItems:YES];
        }
        else 
        {
            key_list = [[NSMutableArray alloc] initWithArray:[self getCustomEquipArray:[selected_entry oo_stringForKey:KEY_KC_DEFINITION]]];
        }
        [gameView clearKeys];   // try to stop key bounces
        [self setGuiToKeyConfigScreen:YES];
    }
 
    if ([gameView isDown:'u'])
    {
        // pressed 'u' on an "more" line
        if ([key hasPrefix:@"More:"]) return;
 
        current_row = [gui selectedRow];
        [self unsetKeySetting:[[keyFunctions objectAtIndex:selFunctionIdx] objectForKey:KEY_KC_DEFINITION]];
        [self reloadPage];
    }
 
    if ([gameView isDown:'r'])
    {
        // reset single entry or all
        if (![gameView isCtrlDown]) 
        {
            // pressed 'r' on an "more" line
            if ([key hasPrefix:@"More:"]) return;
 
            current_row = [gui selectedRow];
            
            NSString *delkey = [[keyFunctions objectAtIndex:selFunctionIdx] objectForKey:KEY_KC_DEFINITION];
            [self deleteKeySetting:delkey];
            // special case - when default activate/mode key set in custom equipment
            if ([self entryIsCustomEquip:delkey]) 
            {
                int idx = [self getCustomEquipIndex:delkey];
                NSString *eq = nil;
                NSString *lookupKey = nil;
                bool update = false;
 
                if ([delkey hasPrefix:@"activate_"]) 
                {
                    eq = [delkey stringByReplacingOccurrencesOfString:@"activate_" withString:@""];
                    lookupKey = CUSTOMEQUIP_KEYACTIVATE;
                }
                if ([delkey hasPrefix:@"mode_"]) 
                {
                    eq = [delkey stringByReplacingOccurrencesOfString:@"mode_" withString:@""];
                    lookupKey = CUSTOMEQUIP_KEYMODE;
                }
 
                OOEquipmentType *item = [OOEquipmentType equipmentTypeWithIdentifier:eq];
                
                if ([item defaultActivateKey] && [lookupKey isEqualToString:CUSTOMEQUIP_KEYACTIVATE]) 
                {
                    [[customEquipActivation objectAtIndex:idx] setObject:[item defaultActivateKey] forKey:lookupKey];
                    update = true;
                }
                if ([item defaultModeKey] && [lookupKey isEqualToString:CUSTOMEQUIP_KEYMODE]) 
                {
                    [[customEquipActivation objectAtIndex:idx] setObject:[item defaultModeKey] forKey:lookupKey];
                    update = true;
                }
 
                if (update) 
                {
                    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
                    [defaults setObject:customEquipActivation forKey:KEYCONFIG_CUSTOMEQUIP];
                }
            }
            
            [self reloadPage];
        }
        else
        {
            [self setGuiToConfirmClearScreen];
        }
    }
    if ([gameView isDown:' '] && !has_error) [self setGuiToGameOptionsScreen];
}

laserHeatLevel

- (GLfloat) laserHeatLevel

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat result = (GLfloat)weapon_temp / (GLfloat)PLAYER_MAX_WEAPON_TEMP;
    return OOClamp_0_1_f(result);
}

laserHeatLevelAft

- (GLfloat) laserHeatLevelAft

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat result = aft_weapon_temp / (GLfloat)PLAYER_MAX_WEAPON_TEMP;
    return OOClamp_0_1_f(result);
}

laserHeatLevelForward

- (GLfloat) laserHeatLevelForward

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat result = forward_weapon_temp / (GLfloat)PLAYER_MAX_WEAPON_TEMP;
// no need to check subents here
    return OOClamp_0_1_f(result);
}

laserHeatLevelPort

- (GLfloat) laserHeatLevelPort

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat result = port_weapon_temp / PLAYER_MAX_WEAPON_TEMP;
    return OOClamp_0_1_f(result);
}

laserHeatLevelStarboard

- (GLfloat) laserHeatLevelStarboard

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    GLfloat result = starboard_weapon_temp / PLAYER_MAX_WEAPON_TEMP;
    return OOClamp_0_1_f(result);
}

lastsaveName

- (NSString *) lastsaveName

Definition at line 9242 of file PlayerEntity.m.

{
    return _lastsaveName;
}

launchEscapeCapsule

- (ShipEntity *) launchEscapeCapsule

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    ShipEntity      *doppelganger = nil;
    ShipEntity      *escapePod = nil;
    
    if ([UNIVERSE displayGUI]) [self switchToMainView]; // Clear the F7 screen!
    [UNIVERSE setViewDirection:VIEW_FORWARD];
    
    if ([self status] == STATUS_DEAD)  return nil;
    
    /*
        While inside the escape pod, we need to block access to all player.ship properties,
        since we're not supposed to be inside our ship anymore! -- Kaks 20101114
    */
    
    [UNIVERSE setBlockJSPlayerShipProps:YES];   // no player.ship properties while inside the pod!
    // if a specific amount of time has been provided for the rescue, use it now
    if (escape_pod_rescue_time > 0) 
    {
        ship_clock_adjust += escape_pod_rescue_time;
        escape_pod_rescue_time = 0; // reset value
    } 
    else 
    {
        // otherwise, use the default time calc
        ship_clock_adjust += 43200 + 5400 * (ranrot_rand() & 127);  // add up to 8 days until rescue!
    }
    dockingClearanceStatus = DOCKING_CLEARANCE_STATUS_NOT_REQUIRED;
    flightSpeed = fmin(flightSpeed, maxFlightSpeed);
    
    doppelganger = [self createDoppelganger];
    if (doppelganger)
    {
        [doppelganger setVelocity:vector_multiply_scalar(v_forward, flightSpeed)];
        [doppelganger setSpeed:0.0];
        [doppelganger setDesiredSpeed:0.0];
        [doppelganger setRoll:0.2 * (randf() - 0.5)];
        [doppelganger setOwner:self];
        [doppelganger setThrust:0]; // drifts
        [UNIVERSE addEntity:doppelganger];
    }
 
    [self setFoundTarget:doppelganger]; // must do this before setting status
    [self setStatus:STATUS_ESCAPE_SEQUENCE];    // now set up the escape sequence.
 
 
    // must do this before next step or uses BBox of pod, not old ship!
    float sheight = (float)(boundingBox.max.y - boundingBox.min.y);
    position = HPvector_subtract(position, vectorToHPVector(vector_multiply_scalar(v_up, sheight)));
    float sdepth = (float)(boundingBox.max.z - boundingBox.min.z);
    position = HPvector_subtract(position, vectorToHPVector(vector_multiply_scalar(v_forward, sdepth/2.0)));
 
    // set up you
    escapePod = [UNIVERSE newShipWithName:@"escape-capsule"];   // retained
    if (escapePod != nil)
    {
        // FIXME: this should use OOShipType, which should exist. -- Ahruman
        [self setMesh:[escapePod mesh]];
    }
    
    /* These used to be non-zero, but BEHAVIOUR_IDLE levels off flight
     * anyway, and inertial velocity is used instead of inertialess
     * thrust - CIM */
    flightSpeed = 0.0f;
    flightPitch = 0.0f;
    flightRoll = 0.0f;
    flightYaw = 0.0f;
    // and turn off inertialess drive
    thrust = 0.0f;
    
 
    /*  Add an impulse upwards and backwards to the escape pod. This avoids
        flying straight through the doppelganger in interstellar space or when
        facing the main station/escape target, and generally looks cool.
        -- Ahruman 2011-04-02
    */
    Vector launchVector = vector_add([doppelganger velocity],
                            vector_add(vector_multiply_scalar(v_up, 15.0f),
                                       vector_multiply_scalar(v_forward, -90.0f)));
    [self setVelocity:launchVector];
    
 
 
    // if multiple items providing escape pod, remove the first one
    [self removeEquipmentItem:[self equipmentItemProviding:@"EQ_ESCAPE_POD"]];
 
    
    // set up the standard location where the escape pod will dock.
    target_system_id = system_id;           // we're staying in this system
    info_system_id = system_id;
    [self setDockTarget:[UNIVERSE station]];    // we're docking at the main station, if there is one
    
    [self doScriptEvent:OOJSID("shipLaunchedEscapePod") withArgument:escapePod];    // no player.ship properties should be available to script
 
    // reset legal status
    [self setBounty:0 withReason:kOOLegalStatusReasonEscapePod];
    bounty = 0;
 
    // new ship, so lose some memory of player actions
    if (ship_kills >= 6400)
    {
        [self clearRolesFromPlayer:0.1];
    }
    else if (ship_kills >= 2560)
    {
        [self clearRolesFromPlayer:0.25];
    }
    else
    {
        [self clearRolesFromPlayer:0.5];
    }   
 
    // reset trumbles
    if (trumbleCount != 0)  trumbleCount = 1;
    
    // remove cargo
    [cargo removeAllObjects];
    
    energy = 25;
    [UNIVERSE addMessage:DESC(@"escape-sequence") forCount:4.5];
    [self resetShotTime];
    
    // need to zero out all facings shot_times too, otherwise we may end up
    // with a broken escape pod sequence - Nikos 20100909
    forward_shot_time = 0.0;
    aft_shot_time = 0.0;
    port_shot_time = 0.0;
    starboard_shot_time = 0.0;
    
    [escapePod release];
    
    return doppelganger;
}

launchFromStation

- (void) launchFromStation

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    // ensure autosave is ready for the next unscripted launch
    if ([UNIVERSE autoSave]) [UNIVERSE setAutoSaveNow:YES];
    if ([self status] == STATUS_DOCKING)  [self setStatus:STATUS_DOCKED]; // needed here to prevent the normal update from continuing with docking.
    [self leaveDock:[self dockedStation]];
}

launchMine:

- (ShipEntity *) launchMine:

(ShipEntity *)

mine

Definition at line 13727 of file PlayerEntity.m.

                           :(ShipEntity*) mine
{
    if (!mine)
        return nil;
        
    if (![self weaponsOnline])
        return nil;
        
    [mine setOwner: self];
    [mine setBehaviour: BEHAVIOUR_IDLE];
    [self dumpItem: mine];  // includes UNIVERSE addEntity: CLASS_CARGO, STATUS_IN_FLIGHT, AI state GLOBAL ( the last one starts the timer !)
    [mine setScanClass: CLASS_MINE];
    
    float  mine_speed = 500.0f;
    Vector mvel = vector_subtract([mine velocity], vector_multiply_scalar(v_forward, mine_speed));
    [mine setVelocity: mvel];
    [self doScriptEvent:OOJSID("shipReleasedEquipment") withArgument:mine];
    return mine;
}

leaveDock:

- (void) leaveDock: (StationEntity *)  station

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                  :(StationEntity *)station
{
    if (station == nil)  return;
    NSParameterAssert(station == [self dockedStation]);
    
    // ensure we've not left keyboard entry on
    [[UNIVERSE gameView] allowStringInput: NO];
    
    if (gui_screen == GUI_SCREEN_MISSION)
    {
        [[UNIVERSE gui] clearBackground];
        if (_missionWithCallback)
        {
            [self doMissionCallback];
        }
        // notify older scripts, but do not trigger missionScreenOpportunity.
        [self doWorldEventUntilMissionScreen:OOJSID("missionScreenEnded")];
    }
    
    if ([station marketMonitored])
    {
        // 'leaving with those guns were you sir?'
        OOCreditsQuantity oldbounty = [self bounty];
        [self markAsOffender:[station legalStatusOfManifest:shipCommodityData export:YES] withReason:kOOLegalStatusReasonIllegalExports];
        if ([self bounty] > oldbounty)
        {
            [self addRoleToPlayer:@"trader-smuggler"];
        }
    }
    OOGUIScreenID   oldScreen = gui_screen;
    gui_screen = GUI_SCREEN_MAIN;
    [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
 
    if (![hud nonlinearScanner])
    {
        [hud setScannerZoom: 1.0];
    }
    [self loadCargoPods];
    // do not do anything that calls JS handlers between now and calling
    // [station launchShip] below, or the cargo returned by JS may be off
    // CIM - 3.2.2012
    
    // clear the way
    [station autoDockShipsOnApproach];
    [station clearDockingCorridor];
 
//  [self setAlertFlag:ALERT_FLAG_DOCKED to:NO];
    [self clearAlertFlags];
    [self setDockingClearanceStatus:DOCKING_CLEARANCE_STATUS_NONE];
    
    scanner_zoom_rate = 0.0f;
    currentWeaponFacing = WEAPON_FACING_FORWARD;
    [self currentWeaponStats];
    
    forward_weapon_temp = 0.0f;
    aft_weapon_temp = 0.0f;
    port_weapon_temp = 0.0f;
    starboard_weapon_temp = 0.0f;
    
    forward_shield = [self maxForwardShieldLevel];
    aft_shield = [self maxAftShieldLevel];
 
    [self clearTargetMemory];
    [self setShowDemoShips:NO];
    [UNIVERSE setDisplayText:NO];
    [[UNIVERSE gameController] setMouseInteractionModeForFlight];
 
    [[UNIVERSE gameView] clearKeys];    // try to stop keybounces
    
    if ([self isMouseControlOn])
    {
        [[UNIVERSE gameView] resetMouse];
    }
    
    [[OOMusicController sharedController] stop];
 
    [UNIVERSE forceWitchspaceEntries];
    ship_clock_adjust += 600.0;         // 10 minutes to leave dock
    velocity = kZeroVector; // just in case
 
    [station launchShip:self];
 
    launchRoll = -flightRoll; // save the station's spin. (inverted for player)
    flightRoll = 0; // don't spin when showing the break pattern.
    [UNIVERSE setUpBreakPattern:[self breakPatternPosition] orientation:orientation forDocking:YES];
 
    [self setDockedStation:nil];
    
    suppressAegisMessages = YES;
    [self checkForAegis];
    suppressAegisMessages = NO;
    ident_engaged = NO;
    
    [UNIVERSE removeDemoShips];
    // MKW - ensure GUI Screen ship is removed
    [demoShip release];
    demoShip = nil;
    
    [self playLaunchFromStation];
}

leaveWitchspace

- (void) leaveWitchspace

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    double      d1 = SCANNER_MAX_RANGE * ((Ranrot() & 255)/256.0 - 0.5);
    HPVector        pos = [UNIVERSE getWitchspaceExitPosition];     // no need to reset the PRNG
    Quaternion  q1;
    HPVector        whpos, exitpos;
 
    double min_d1 = [UNIVERSE safeWitchspaceExitDistance];
    quaternion_set_random(&q1);
    if (abs((int)d1) < min_d1)
    {
        d1 += ((d1 > 0.0)? min_d1: -min_d1); // not too close to the buoy.
    }
    HPVector        v1 = HPvector_forward_from_quaternion(q1);
    exitpos = HPvector_add(pos, HPvector_multiply_scalar(v1, d1)); // randomise exit position
    position = exitpos;
    [self setOrientation:[UNIVERSE getWitchspaceExitRotation]];
 
    // While setting the wormhole position to the player position looks very nice for ships following the player, 
    // the more common case of the player following other ships, the player tends to
    // ram the back of the ships, or even jump on top of is when the ship jumped without initial speed, which is messy. 
    // To avoid this problem, a small wormhole displacement is added.
    if (wormhole)   // will be nil for galactic jump
    {
        if ([[wormhole shipsInTransit] count] > 0)
        {
            // player is not allone in his wormhole, synchronise player and wormhole position.
            double  wh_arrival_time = ([PLAYER clockTimeAdjusted] - [wormhole arrivalTime]);
            if (wh_arrival_time > 0)
            {
                // Player is following other ship 
                whpos = HPvector_add(exitpos, vectorToHPVector(vector_multiply_scalar([self forwardVector], 1000.0f)));
                [wormhole setContainsPlayer:YES];
            }
            else
            {
                // Player is the leadship 
                whpos = HPvector_add(exitpos, vectorToHPVector(vector_multiply_scalar([self forwardVector], -500.0f)));
                // so it won't contain the player by the time they exit
                [wormhole setExitSpeed:maxFlightSpeed*WORMHOLE_LEADER_SPEED_FACTOR];
            } 
 
            HPVector distance = HPvector_subtract(whpos, pos);
            if (HPmagnitude2(distance) < min_d1*min_d1 ) // within safety distance from the buoy?
            {
                // the wormhole is to close to the buoy. Move both player and wormhole away from it in the x-y plane.
                distance.z = 0;
                distance = HPvector_multiply_scalar(HPvector_normal(distance), min_d1);
                whpos = HPvector_add(whpos, distance);
                position = HPvector_add(position, distance);
            }
            [wormhole setExitPosition: whpos];
        }
        else
        {
            // no-one else in the wormhole
            [wormhole setExitSpeed:maxFlightSpeed*WORMHOLE_LEADER_SPEED_FACTOR];
        }
    }
    /* there's going to be a slight pause at this stage anyway;
     * there's also going to be a lot of stale ship scripts. Force a
     * garbage collection while we have chance. - CIM */
    [[OOJavaScriptEngine sharedEngine] garbageCollectionOpportunity:YES];
    flightSpeed = wormhole ? [wormhole exitSpeed] : fmin(maxFlightSpeed,50.0f);
    [wormhole release]; // OK even if nil
    wormhole = nil;
 
    flightRoll = 0.0f;
    flightPitch = 0.0f;
    flightYaw = 0.0f;
 
    velocity = kZeroVector;
    [self setStatus:STATUS_EXITING_WITCHSPACE];
    gui_screen = GUI_SCREEN_MAIN;
    being_fined = NO;               // until you're scanned by a copper!
    [self clearTargetMemory];
    [self setShowDemoShips:NO];
    [[UNIVERSE gameController] setMouseInteractionModeForFlight];
    [UNIVERSE setDisplayText:NO];
    [UNIVERSE setWitchspaceBreakPattern:YES];
    [self playExitWitchspace];
    if ([self currentSystemID] >= 0)
    {
        if (![roleSystemList containsObject:[NSNumber numberWithInt:[self currentSystemID]]])
        {
            // going somewhere new?
            [self clearRoleFromPlayer:NO];
        }
    }
    
    if (galactic_witchjump)
    {
        [self doScriptEvent:OOJSID("playerEnteredNewGalaxy") withArgument:[NSNumber numberWithUnsignedInt:galaxy_number]];
    }
    
    [self doScriptEvent:OOJSID("shipWillExitWitchspace") withArgument:[self jumpCause]];
    [UNIVERSE setUpBreakPattern:[self breakPatternPosition] orientation:orientation forDocking:NO];
}

legalStatusOfCargoList

- (unsigned) legalStatusOfCargoList

Definition at line 13727 of file PlayerEntity.m.

{
    NSString        *good = nil;
    OOCargoQuantity amount;
    unsigned        penalty = 0;
 
    foreach (good, [shipCommodityData goods])
    {
        amount = [shipCommodityData quantityForGood:good];
        penalty += [shipCommodityData exportLegalityForGood:good] * amount;
    }
    return penalty;
}

loadCargoPods

- (void) loadCargoPods

Definition at line 13727 of file PlayerEntity.m.

{
    /* loads commodities from the ships manifest into individual cargo pods */
    NSString *good = nil;
    foreach (good, [shipCommodityData goods])
    {
        [self loadCargoPodsForType:good fromManifest:shipCommodityData];
    }
    [self calculateCurrentCargo];   // work out the correct value for current_cargo
    cargo_dump_time = 0;
}

loadCargoPodsForType:amount:

- (void) loadCargoPodsForType:		(OOCommodityType)	type
amount:		(OOCargoQuantity)	quantity

Definition at line 13727 of file PlayerEntity.m.

                             :(OOCommodityType)type amount:(OOCargoQuantity)quantity
{
    OOMassUnit unit = [shipCommodityData massUnitForGood:type];
    
    while (quantity)
    {
        if (unit != UNITS_TONS)
        {
            int amount_per_container = (unit == UNITS_KILOGRAMS)? KILOGRAMS_PER_POD : GRAMS_PER_POD;
            while (quantity > 0)
            {
                int smaller_quantity = 1 + ((quantity - 1) % amount_per_container);
                if ([cargo count] < [self maxAvailableCargoSpace])
                {
                    ShipEntity* container = [UNIVERSE newShipWithRole:@"1t-cargopod"];
                    if (container)
                    {
                        // the cargopod ship is just being set up. If ejected,  will call UNIVERSE addEntity
                        [container setStatus:STATUS_IN_HOLD];
                        [container setScanClass: CLASS_CARGO];
                        [container setCommodity:type andAmount:smaller_quantity];
                        [cargo addObject:container];
                        [container release];
                    }
                }
                else
                {
                    // try to squeeze any surplus, up to half a ton, in the manifest.
                    int amount = [shipCommodityData quantityForGood:type] + smaller_quantity;
                    if (amount > MAX_GRAMS_IN_SAFE && unit == UNITS_GRAMS) amount = MAX_GRAMS_IN_SAFE;
                    else if (amount > MAX_KILOGRAMS_IN_SAFE && unit == UNITS_KILOGRAMS) amount = MAX_KILOGRAMS_IN_SAFE;
 
                    [shipCommodityData setQuantity:amount forGood:type];
                }
                quantity -= smaller_quantity;
            }
        }
        else
        {
            // put each ton in a separate container
            while (quantity)
            {
                if ([cargo count] < [self maxAvailableCargoSpace])
                {
                    ShipEntity* container = [UNIVERSE newShipWithRole:@"1t-cargopod"];
                    if (container)
                    {
                        // the cargopod ship is just being set up. If ejected, will call UNIVERSE addEntity
                        [container setScanClass: CLASS_CARGO];
                        [container setStatus:STATUS_IN_HOLD];
                        [container setCommodity:type andAmount:1];
                        [cargo addObject:container];
                        [container release];
                    }
                }
                quantity--;
            }
        }
    }
}

loadCargoPodsForType:fromManifest:

- (void) loadCargoPodsForType:		(OOCommodityType)	type
fromManifest:		(OOCommodityMarket *)	manifest

Definition at line 13727 of file PlayerEntity.m.

                             :(OOCommodityType)type fromManifest:(OOCommodityMarket *) manifest
{
    // load commodities from the ships manifest into individual cargo pods
    unsigned j;
    
    OOCargoQuantity quantity = [manifest quantityForGood:type];
    OOMassUnit      units = [manifest massUnitForGood:type];
    
    if (quantity > 0)
    {
        if (units == UNITS_TONS)
        {
            // easy case
            for (j = 0; j < quantity; j++)
            {
                [self createCargoPodWithType:type andAmount:1];     // or CTD if unsuccesful (!)
            }
            [manifest setQuantity:0 forGood:type];
        }
        else
        {
            OOCargoQuantity podsRequiredForQuantity, amountToLoadInCargopod, tmpQuantity;
            // reserve up to 1/2 ton of each commodity for the safe
            if (units == UNITS_KILOGRAMS) 
            {
                if (quantity <= MAX_KILOGRAMS_IN_SAFE)
                {
                    tmpQuantity = quantity;
                     quantity = 0;
                }
                else
                {
                    tmpQuantity = MAX_KILOGRAMS_IN_SAFE;
                    quantity -= tmpQuantity;
                }
                amountToLoadInCargopod = KILOGRAMS_PER_POD;
            }
            else
            {
                if (quantity <= MAX_GRAMS_IN_SAFE) {
                    tmpQuantity = quantity;
                    quantity = 0;
                }
                else
                {
                    tmpQuantity = MAX_GRAMS_IN_SAFE;
                    quantity -= tmpQuantity;
                }
                amountToLoadInCargopod = GRAMS_PER_POD;
            }
            if (quantity > 0)
            {
                podsRequiredForQuantity = 1 + (quantity/amountToLoadInCargopod);
                // this check is needed so that initial quantities like 1499kg or 1499999g
                // do not result in generation of an empty cargopod
                if (quantity % amountToLoadInCargopod == 0)  podsRequiredForQuantity--;
                
                // put each ton or part-ton beyond that in a separate container
                for (j = 0; j < podsRequiredForQuantity; j++)
                {
                    if (amountToLoadInCargopod > quantity)
                    {
                        // last pod gets the dregs. :)
                        amountToLoadInCargopod = quantity;
                    }
                    [self createCargoPodWithType:type andAmount:amountToLoadInCargopod];    // or CTD if unsuccesful (!)
                    quantity -= amountToLoadInCargopod;
                }
                // adjust manifest for this commodity
                [manifest setQuantity:tmpQuantity forGood:type];
            }
        }
    }
}

loadKeySettings

- (NSDictionary *) loadKeySettings

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

{
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    return [defaults objectForKey:KEYCONFIG_OVERRIDES];
}

loadPlayer

- (BOOL) loadPlayer

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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];
 
    // if the file was specified in the command line at startup, DO NOT suppress the keys!
    if ([[UNIVERSE gameController] finishedLaunching])  [[UNIVERSE gameView] suppressKeysUntilKeyUp];
    if (asNew) 
    {
        gui_screen = GUI_SCREEN_NEWGAME;
    }
    else 
    {
        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;
}

localMarket

- (OOCommodityMarket *) localMarket

Definition at line 9242 of file PlayerEntity.m.

{
    StationEntity *station = [self dockedStation];
    if (station == nil)  
    {
        if ([[self primaryTarget] isStation] && [(StationEntity *)[self primaryTarget] marketBroadcast])
        {
            station = [self primaryTarget];
        }
        else
        {
            station = [UNIVERSE station];
        }
        if (station == nil)
        {
            // interstellar space or similar
            return nil;
        }
    }
    OOCommodityMarket *localMarket = [station localMarket];
    if (localMarket == nil)
    {
        localMarket = [station initialiseLocalMarket];
    }
    
    return localMarket;
}

localVariableForKey:andMission:

- (NSString *) localVariableForKey:		(NSString *)	variableName
andMission:		(NSString *)	missionKey

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                                 :(NSString *)variableName andMission:(NSString *)missionKey
{
    return [[localVariables oo_dictionaryForKey:missionKey] objectForKey:variableName];
}

localVariablesForMission:

- (NSMutableDictionary *) localVariablesForMission:

(NSString *)

missionKey

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                                                 :(NSString *)missionKey
{
    NSMutableDictionary     *result = nil;
    
    if (missionKey == nil)  return nil;
    
    result = [localVariables objectForKey:missionKey];
    if (result == nil)
    {
        result = [NSMutableDictionary dictionary];
        [localVariables setObject:result forKey:missionKey];
    }
    
    return result;
}

Referenced by PlayerEntity(Scripting)::PerformActionStatment.

Here is the caller graph for this function:

longRangeChartMode

- (OOLongRangeChartMode) longRangeChartMode

lookingAtSunWithThresholdAngleCos:

- (GLfloat) lookingAtSunWithThresholdAngleCos: (GLfloat)  thresholdAngleCos

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                                             :(GLfloat) thresholdAngleCos
{
    OOSunEntity *sun = [UNIVERSE sun];
    GLfloat measuredCos = 999.0f, measuredCosAbs;
    GLfloat sunBrightness = 0.0f;
    Vector relativePosition, unitRelativePosition;
    
    if (EXPECT_NOT(!sun))  return 0.0f;
    
    // check if camera position is shadowed
    OOViewID vdir = [UNIVERSE viewDirection];
    unsigned i;
    unsigned    ent_count = UNIVERSE->n_entities;
    Entity      **uni_entities = UNIVERSE->sortedEntities;  // grab the public sorted list
    for (i = 0; i < ent_count; i++)
    {
        if (uni_entities[i]->isSunlit)
        {
            if ([uni_entities[i] isPlanet] || 
                ([uni_entities[i] isShip] &&
                 [uni_entities[i] isVisible]))
            {
                // the player ship can't shadow internal views
                if (EXPECT(vdir > VIEW_STARBOARD || ![uni_entities[i] isPlayer]))
                {
                    float shadow = 1.5f;
                    shadowAtPointOcclusionToValue([self viewpointPosition],1.0f,uni_entities[i],sun,&shadow);
                    /* BUG: if the shadowing entity is not spherical, this gives over-shadowing. True elsewhere as well, but not so obvious there. */
                    if (shadow < 1) {
                        return 0.0f;
                    }
                }
            }
        }
    }
 
 
    relativePosition = HPVectorToVector(HPvector_subtract([self viewpointPosition], [sun position]));
    unitRelativePosition = vector_normal_or_zbasis(relativePosition);
    switch (vdir)
    {
        case VIEW_FORWARD:
            measuredCos = -dot_product(unitRelativePosition, v_forward);
            break;
        case VIEW_AFT:
            measuredCos = +dot_product(unitRelativePosition, v_forward);
            break;
        case VIEW_PORT:
            measuredCos = +dot_product(unitRelativePosition, v_right);
            break;
        case VIEW_STARBOARD:
            measuredCos = -dot_product(unitRelativePosition, v_right);
            break;
        case VIEW_CUSTOM:
            {
                Vector relativeView = [self customViewForwardVector];
                Vector absoluteView = quaternion_rotate_vector(quaternion_conjugate([self orientation]),relativeView);
                measuredCos = -dot_product(unitRelativePosition, absoluteView);
            }
            break;
            
        default:
            break;
    }
    measuredCosAbs = fabs(measuredCos);
    /*
      Bugfix: 1.1f - floating point errors can mean the dot product of two
      normalised vectors can be very slightly more than 1, which can
      cause extreme flickering of the glare at certain ranges to the
      sun. The real test is just that it's not still 999 - CIM
     */
    if (thresholdAngleCos <= measuredCosAbs && measuredCosAbs <= 1.1f)  // angle from viewpoint to sun <= desired threshold
    {
        sunBrightness =  (measuredCos - thresholdAngleCos) / (1.0f - thresholdAngleCos);
//      OOLog(@"glare.debug",@"raw brightness = %f",sunBrightness);
        if (sunBrightness < 0.0f)  sunBrightness = 0.0f;
        else if (sunBrightness > 1.0f)  sunBrightness = 1.0f;
    }
//  OOLog(@"glare.debug",@"cos=%f, threshold = %f, brightness = %f",measuredCosAbs,thresholdAngleCos,sunBrightness);
    return sunBrightness * sunBrightness * sunBrightness;
}

loseTargetStatus

- (void) loseTargetStatus

Definition at line 13727 of file PlayerEntity.m.

{
    if (!UNIVERSE)
        return;
    int         ent_count =     UNIVERSE->n_entities;
    Entity**    uni_entities =  UNIVERSE->sortedEntities;   // grab the public sorted list
    Entity*     my_entities[ent_count];
    int i;
    for (i = 0; i < ent_count; i++)
        my_entities[i] = [uni_entities[i] retain];      //  retained
    for (i = 0; i < ent_count ; i++)
    {
        Entity* thing = my_entities[i];
        if (thing->isShip)
        {
            ShipEntity* ship = (ShipEntity *)thing;
            if (self == [ship primaryTarget])
            {
                [ship noteLostTarget];
            }
        }
    }
    for (i = 0; i < ent_count; i++)
    {
        [my_entities[i] release];       //  released
    }
}

lsCommanders:directory:pageNumber:highlightName:

- (void) lsCommanders: (GuiDisplayGen *)  gui directory: (NSString*)  directory pageNumber: (int)  page highlightName: (NSString *)  highlightName

implementation

Provided by category PlayerEntity(OOLoadSavePrivate).

Definition at line 1011 of file PlayerEntityLoadSave.m.

                     : (GuiDisplayGen *)gui
            directory: (NSString*) directory
           pageNumber: (int)page
        highlightName: (NSString *)highlightName
{
    NSFileManager *cdrFileManager=[NSFileManager defaultManager];
    int rangeStart=STARTROW;
    unsigned lastIndex;
    unsigned i;
    int row=STARTROW;
    
    // cdrArray defined in PlayerEntity.h
    NSArray *cdrArray=[cdrFileManager commanderContentsOfPath: directory];
    
    // get commander details so a brief rundown of the commander's details may
    // be displayed.
    if (!cdrDetailArray)
        cdrDetailArray=[[NSMutableArray alloc] init];   // alloc retains this so the retain further on in the code was unnecessary
    else
        [cdrDetailArray removeAllObjects];
    
    [cdrDetailArray addObject:[NSMutableDictionary dictionaryWithObjectsAndKeys:
        @"YES", @"isParentFolder",
        [directory stringByDeletingLastPathComponent], @"saved_game_path", nil]];
    
    for(i = 0; i < [cdrArray count]; i++)
    {
        NSString*   path = [cdrArray objectAtIndex:i];
        BOOL        exists, isDirectory = NO;
        
        exists = [cdrFileManager fileExistsAtPath:path isDirectory:&isDirectory];
        
        if (exists)
        {
            if (!isDirectory && [[[path pathExtension] lowercaseString] isEqualToString:@"oolite-save"])
            {
                NSDictionary *cdr = OODictionaryFromFile(path);
                if(cdr)
                {
                    // okay use the same dictionary but add a 'saved_game_path' attribute
                    NSMutableDictionary* cdr1 = [NSMutableDictionary dictionaryWithDictionary:cdr];
                    [cdr1 setObject: @"YES" forKey:@"isSavedGame"];
                    [cdr1 setObject: path forKey:@"saved_game_path"];
                    [cdrDetailArray addObject: cdr1];
                }
            }
            if (isDirectory && ![[path lastPathComponent] hasPrefix:@"."])
            {
                [cdrDetailArray addObject: [NSDictionary dictionaryWithObjectsAndKeys: @"YES", @"isFolder", path, @"saved_game_path", nil]];
            }
        }
    }
    
    if(![cdrDetailArray count])
    {
        // Empty directory; tell the user and exit immediately.
        [gui setText:DESC(@"loadsavescreen-no-commanders-found") forRow:STARTROW align:GUI_ALIGN_CENTER];
        return;
    }
 
    [cdrDetailArray sortUsingFunction:sortCommanders context:NULL];
    
    // Do we need to highlight a name?
    int highlightRowOnPage=STARTROW;
    int highlightIdx=0;
    if(highlightName)
    {
        highlightIdx=[self findIndexOfCommander: highlightName];
        if(highlightIdx < 0)
        {
            OOLog(@"save.list.commanders.commanderNotFound", @"Commander %@ doesn't exist, very bad", highlightName);
            highlightIdx=0;
        }
        
        // figure out what page we need to be on
        page=highlightIdx/NUMROWS;
        highlightRowOnPage=highlightIdx % NUMROWS + STARTROW;
    }
    
    // We now know for certain what page we're on - 
    // set the first index of the first commander on this page.
    unsigned firstIndex=page * NUMROWS;
    
    // Set up the GUI.
    OOGUITabSettings tabStop;
    tabStop[0]=0;
    tabStop[1]=160;
    tabStop[2]=270;
    [gui setTabStops: tabStop];
    
    // clear text lines here
    for (i = EXITROW ; i < ENDROW + 1; i++)
    {
        [gui setText:@"" forRow:i align:GUI_ALIGN_LEFT];
        [gui setColor: [OOColor yellowColor] forRow: i];
        [gui setKey:GUI_KEY_SKIP forRow:i];
    }
 
    [gui setColor: [OOColor greenColor] forRow: LABELROW];
    [gui setArray: [NSArray arrayWithObjects: DESC(@"loadsavescreen-commander-name"), DESC(@"loadsavescreen-rating"), nil]
           forRow:LABELROW];
 
    if (page)
    {
        [gui setColor:[OOColor greenColor] forRow:STARTROW-1];
        [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-back"), @" <-- ", nil]
               forRow:STARTROW-1];
        [gui setKey:GUI_KEY_OK forRow:STARTROW-1];
        rangeStart=STARTROW-1;
    }
 
    if ([self status] == STATUS_START_GAME)
    {
        [gui setArray:[NSArray arrayWithObjects:DESC(@"oolite-loadsave-exit"), @" <----- ", nil] forRow:EXITROW];
        [gui setColor:[OOColor redColor] forRow:EXITROW];
        [gui setKey:GUI_KEY_OK forRow:EXITROW];
        rangeStart = EXITROW;
    }
 
    
    if (firstIndex + NUMROWS >= [cdrDetailArray count])
    {
        lastIndex=[cdrDetailArray count];
        [gui setSelectableRange: NSMakeRange(rangeStart, rangeStart + NUMROWS + 2)];
    }
    else
    {
        lastIndex=(page * NUMROWS) + NUMROWS;
        [gui setColor:[OOColor greenColor] forRow:ENDROW];
        [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-more"), @" --> ", nil]
               forRow:ENDROW];
        [gui setKey:GUI_KEY_OK forRow:ENDROW];
        [gui setSelectableRange: NSMakeRange(rangeStart, MOREROW)];
    }
    
    for (i=firstIndex; i < lastIndex; i++)
    {
        NSDictionary *cdr=[cdrDetailArray objectAtIndex: i];
        if ([cdr oo_boolForKey:@"isSavedGame"])
        {
            NSString *ratingDesc = OODisplayRatingStringFromKillCount([cdr oo_unsignedIntForKey:@"ship_kills"]);
            [gui setArray:[NSArray arrayWithObjects:
                [NSString stringWithFormat:@" %@ ",[cdr oo_stringForKey:@"player_save_name" defaultValue:[cdr oo_stringForKey:@"player_name"]]],
                [NSString stringWithFormat:@" %@ ",ratingDesc],
                nil]
                   forRow:row];
            if ([[self lastsaveName] isEqualToString:[cdr oo_stringForKey:@"player_save_name" defaultValue:[cdr oo_stringForKey:@"player_name"]]])
            {
                highlightRowOnPage = row;
            }
            
            [gui setKey:GUI_KEY_OK forRow:row];
            row++;
        }
        if ([cdr oo_boolForKey:@"isParentFolder"])
        {
            [gui setArray:[NSArray arrayWithObjects:
                [NSString stringWithFormat:@" (..) %@ ", [[cdr oo_stringForKey:@"saved_game_path"] lastPathComponent]],
                @"",
                nil]
                   forRow:row];
            [gui setColor: [OOColor orangeColor] forRow: row];
            [gui setKey:GUI_KEY_OK forRow:row];
            row++;
        }
        if ([cdr oo_boolForKey:@"isFolder"])
        {
            [gui setArray:[NSArray arrayWithObjects:
                [NSString stringWithFormat:@" >> %@ ", [[cdr oo_stringForKey:@"saved_game_path"] lastPathComponent]],
                @"",
                nil]
                   forRow:row];
            [gui setColor: [OOColor orangeColor] forRow: row];
            [gui setKey:GUI_KEY_OK forRow:row];
            row++;
        }
    }
    [gui setSelectedRow: highlightRowOnPage];
    highlightIdx = (highlightRowOnPage - STARTROW) + (currentPage * NUMROWS);
    // show the first ship, this will be the selected row
    [self showCommanderShip: highlightIdx];
}

makeKeyGuiDict:keyDef:

- (NSDictionary *) makeKeyGuiDict:		(NSString *)	what
keyDef:		(NSString *)	keyDef

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                :(NSString *)what keyDef:(NSString*)key_def
{
    NSMutableDictionary *guiDict = [NSMutableDictionary dictionary];
    if ([what length] > 50) what = [[what substringToIndex:48] stringByAppendingString:@"..."];
    [guiDict setObject:what forKey:KEY_KC_GUIDESC];
    [guiDict setObject:key_def forKey:KEY_KC_DEFINITION];
    return guiDict;
}

makeKeyGuiDictHeader:

- (NSDictionary *) makeKeyGuiDictHeader:

(NSString *)

header

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                      :(NSString *)header
{
    NSMutableDictionary *guiDict = [NSMutableDictionary dictionary];
    [guiDict setObject:header forKey:KEY_KC_HEADER];
    [guiDict setObject:@"" forKey:KEY_KC_GUIDESC];
    [guiDict setObject:@"" forKey:KEY_KC_DEFINITION];
    return guiDict;
}

makeStickGuiDict:allowable:axisfn:butfn:

- (NSDictionary *) makeStickGuiDict:		(NSString *)	what
allowable:		(int)	allowable
axisfn:		(int)	axisfn
butfn:		(int)	butfn

Provided by category PlayerEntity(StickMapper).

Definition at line 1 of file PlayerEntityStickMapper.m.

                                  :(NSString *)what
                         allowable:(int)allowable
                            axisfn:(int)axisfn
                             butfn:(int)butfn
{
    NSMutableDictionary *guiDict = [NSMutableDictionary dictionary];
    
    if ([what length] > 50)  what = [[what substringToIndex:28] stringByAppendingString:@"..."];
    [guiDict setObject: what  forKey: KEY_GUIDESC];
    [guiDict setObject: [NSNumber numberWithInt: allowable]  
                forKey: KEY_ALLOWABLE];
    if(axisfn >= 0)
        [guiDict setObject: [NSNumber numberWithInt: axisfn]
                    forKey: KEY_AXISFN];
    if(butfn >= 0)
        [guiDict setObject: [NSNumber numberWithInt: butfn]
                    forKey: KEY_BUTTONFN];
    return guiDict;
}

makeStickGuiDictHeader:

- (NSDictionary *) makeStickGuiDictHeader:

(NSString *)

header

Provided by category PlayerEntity(StickMapper).

Definition at line 1 of file PlayerEntityStickMapper.m.

                                        :(NSString *)header
{
    NSMutableDictionary *guiDict = [NSMutableDictionary dictionary];
    [guiDict setObject:header forKey:KEY_HEADER];
    [guiDict setObject:@"" forKey:KEY_ALLOWABLE];
    [guiDict setObject:@"" forKey:KEY_AXISFN];
    [guiDict setObject:@"" forKey:KEY_BUTTONFN];
    return guiDict;
}

markAsOffender:

- (void) markAsOffender: (int)  offence_value

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                       :(int)offence_value
{
    [self markAsOffender:offence_value withReason:kOOLegalStatusReasonUnknown];
}

markAsOffender:withReason:

- (void) markAsOffender: (int)  offence_value withReason: (OOLegalStatusReason)  reason

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                       :(int)offence_value withReason:(OOLegalStatusReason)reason
{
    if (![self isCloaked])
    {
        JSContext *context = OOJSAcquireContext();
    
        jsval amountVal = JSVAL_VOID;
        int amountVal2 = (legalStatus | offence_value) - legalStatus;
        JS_NewNumberValue(context, amountVal2, &amountVal);
 
        legalStatus |= offence_value; // can't set the new bounty until the size of the change is known
 
        jsval reasonVal = OOJSValueFromLegalStatusReason(context, reason);
        
        ShipScriptEvent(context, self, "shipBountyChanged", amountVal, reasonVal);
        
        OOJSRelinquishContext(context);
 
    }
}

markedDestinations

- (NSDictionary *) markedDestinations

Definition at line 13727 of file PlayerEntity.m.

{
    // get a list of systems marked as contract destinations
    NSMutableDictionary *destinations = [NSMutableDictionary dictionaryWithCapacity:256];
    unsigned        i;
    OOSystemID sysid;
    NSDictionary *marker;
 
    for (i = 0; i < [passengers count]; i++)
    {
        sysid = [[passengers oo_dictionaryAtIndex:i]  oo_unsignedCharForKey:CONTRACT_KEY_DESTINATION];
        marker = [self passengerContractMarker:sysid];
        [self prepareMarkedDestination:destinations:marker];
    }
    for (i = 0; i < [parcels count]; i++)
    {
        sysid = [[parcels oo_dictionaryAtIndex:i]  oo_unsignedCharForKey:CONTRACT_KEY_DESTINATION];
        marker = [self parcelContractMarker:sysid];
        [self prepareMarkedDestination:destinations:marker];
    }
    for (i = 0; i < [contracts count]; i++)
    {
        sysid = [[contracts oo_dictionaryAtIndex:i]  oo_unsignedCharForKey:CONTRACT_KEY_DESTINATION];
        marker = [self cargoContractMarker:sysid];
        [self prepareMarkedDestination:destinations:marker];
    }
 
    NSString                    *key = nil;
 
    foreachkey (key, missionDestinations)
    {
        marker = [missionDestinations objectForKey:key];
        [self prepareMarkedDestination:destinations:marker];
    }
    
    return destinations;
}

markerKey:

- (NSString *) markerKey:

(NSDictionary*)

marker

Definition at line 9242 of file PlayerEntity.m.

                       :(NSDictionary *)marker
{
    return [NSString stringWithFormat:@"%d-%@",[marker oo_intForKey:@"system"], [marker oo_stringForKey:@"name"]];
}

marketScreenTitle

- (NSString *) marketScreenTitle

implementation

Definition at line 9242 of file PlayerEntity.m.

{
    StationEntity *dockedStation = [self dockedStation];
 
    /* Override normal behaviour if station broadcasts market */
    if (dockedStation == nil)  
    {
        if ([[self primaryTarget] isStation] && [(StationEntity *)[self primaryTarget] marketBroadcast])
        {
            dockedStation = [self primaryTarget];
        }
    }
 
    NSString *system = nil;
    if ([UNIVERSE sun] != nil)  system = [UNIVERSE getSystemName:system_id];
    
    if (dockedStation == nil || dockedStation == [UNIVERSE station])
    {
        if ([UNIVERSE sun] != nil)
        {
            return OOExpandKey(@"system-commodity-market", system);
        }
        else
        {
            // Witchspace
            return OOExpandKey(@"commodity-market");
        }
    }
    else
    {
        NSString *station = [dockedStation displayName];
        return OOExpandKey(@"station-commodity-market", station);
    }
}

massLockable

- (BOOL) massLockable

massLocked

- (BOOL) massLocked

Definition at line 13727 of file PlayerEntity.m.

{
    return ((alertFlags & ALERT_FLAG_MASS_LOCK) != 0);
}

maxAftShieldLevel

- (float) maxAftShieldLevel

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    return max_aft_shield;
}

maxForwardShieldLevel

- (float) maxForwardShieldLevel

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    return max_forward_shield;
}

maxPlayerRoles

- (NSUInteger) maxPlayerRoles

Definition at line 13727 of file PlayerEntity.m.

{
    if (ship_kills >= 6400)
    {
        return 32;
    }
    else if (ship_kills >= 128)
    {
        return 16;
    }
    else
    {
        return 8;
    }
}

messageShipAIs:

- (void) messageShipAIs:

(NSString *)

roles_message

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                       :(NSString *)roles_message
{
    NSMutableArray* tokens = ScanTokensFromString(roles_message);
    NSString*   roleString = nil;
    NSString*   messageString = nil;
 
    if ([tokens count] < 2)
    {
        OOLog(kOOLogSyntaxMessageShipAIs, @"***** SCRIPT ERROR: in %@, CANNOT messageShipAIs: '%@' (bad parameter count)", CurrentScriptDesc(), roles_message);
        return;
    }
 
    roleString = [tokens objectAtIndex:0];
    [tokens removeObjectAtIndex:0];
    messageString = [tokens componentsJoinedByString:@" "];
 
    NSArray *targets = [UNIVERSE findShipsMatchingPredicate:HasPrimaryRolePredicate
                                                  parameter:roleString
                                                    inRange:-1
                                                   ofEntity:nil];
 
    ShipEntity *target;
    foreach(target, targets) {
        [[target getAI] reactToMessage:messageString context:@"messageShipAIs:"];
    }
}

missileForPylon:

- (ShipEntity *) missileForPylon:

(NSUInteger)

value

Definition at line 13727 of file PlayerEntity.m.

                                :(NSUInteger)value
{
    if (value < max_missiles)  return missile_entity[value];
    return nil;
}

missilesList

- (NSArray *) missilesList

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    [self tidyMissilePylons];   // just in case.
    return [super missilesList];
}

missingSubEntitiesAdjustment

- (NSInteger) missingSubEntitiesAdjustment

Provided by category PlayerEntity(Contracts).

Definition at line 1443 of file PlayerEntityContracts.m.

{
    // each missing subentity depreciates the ship by 5%, up to a maximum of 35% depreciation.
    NSUInteger percent = 5 * ([self maxShipSubEntities] - [[[self shipSubEntityEnumerator] allObjects] count]);
    return (percent > 35 ? 35 : percent);
}

mission_string

- (NSString *) mission_string

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    return sMissionStringValue;
}

missionBackgroundDescriptor

- (NSDictionary *) missionBackgroundDescriptor

Definition at line 9242 of file PlayerEntity.m.

{
    return _missionBackgroundDescriptor;
}

missionBackgroundDescriptorOrDefault

- (NSDictionary *) missionBackgroundDescriptorOrDefault

Definition at line 9242 of file PlayerEntity.m.

{
    NSDictionary *result = [self missionBackgroundDescriptor];
    if (result == nil)
    {
        result = [UNIVERSE screenTextureDescriptorForKey:@"mission"];
    }
    
    return result;
}

missionBackgroundSpecial

- (OOGUIBackgroundSpecial) missionBackgroundSpecial

Definition at line 9242 of file PlayerEntity.m.

{
    return _missionBackgroundSpecial;
}

missionChoice_string

- (NSString *) missionChoice_string

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return missionChoice;
}

missionExitScreen

- (OOGUIScreenID) missionExitScreen

Definition at line 9242 of file PlayerEntity.m.

{
    return _missionExitScreen;
}

missionKeyPress_string

- (NSString *) missionKeyPress_string

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return missionKeyPress;
}

missionOverlayDescriptor

- (NSDictionary *) missionOverlayDescriptor

Definition at line 9242 of file PlayerEntity.m.

{
    return _missionOverlayDescriptor;
}

missionOverlayDescriptorOrDefault

- (NSDictionary *) missionOverlayDescriptorOrDefault

Definition at line 9242 of file PlayerEntity.m.

{
    NSDictionary *result = [self missionOverlayDescriptor];
    if (result == nil)
    {
        if ([[self missionTitle] length] == 0)
        {
            result = [UNIVERSE screenTextureDescriptorForKey:@"mission_overlay_no_title"];
        }
        else
        {
            result = [UNIVERSE screenTextureDescriptorForKey:@"mission_overlay_with_title"];
        }
    }
    
    return result;
}

missionScreenID

- (NSString *) missionScreenID

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return _missionScreenID;
}

Referenced by MissionGetProperty().

Here is the caller graph for this function:

missionsList

- (NSArray *) missionsList

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    NSEnumerator            *scriptEnum = nil;
    NSString                *scriptName = nil;
    NSString                *vars = nil;
    NSMutableArray          *result1 = nil;
    NSMutableArray          *result2 = nil;
    
    result1 = [NSMutableArray array];
    result2 = [NSMutableArray array];
 
    NSArray*    passengerManifest = [self passengerList];
    NSArray*    contractManifest = [self contractList];
    NSArray*    parcelManifest = [self parcelList]; 
 
    if ([passengerManifest count] > 0)
    {
        [result2 addObject:[[NSArray arrayWithObject:DESC(@"manifest-passengers")] arrayByAddingObjectsFromArray:passengerManifest]];
    }
 
    if ([parcelManifest count] > 0)
    {
        [result2 addObject:[[NSArray arrayWithObject:DESC(@"manifest-parcels")] arrayByAddingObjectsFromArray:parcelManifest]];
    }
 
    if ([contractManifest count] > 0)
    {
        [result2 addObject:[[NSArray arrayWithObject:DESC(@"manifest-contracts")] arrayByAddingObjectsFromArray:contractManifest]];
    }
 
    /* For proper display, array entries need to all be after string
     * entries, so sort them now */ 
    for (scriptEnum = [worldScripts keyEnumerator]; (scriptName = [scriptEnum nextObject]); )
    {
        vars = [mission_variables objectForKey:scriptName];
        
        if (vars != nil)
        {
            if ([vars isKindOfClass:[NSString class]])
            {
                [result1 addObject:vars];
            }
            else if ([vars isKindOfClass:[NSArray class]])
            {
                BOOL found = NO;
                NSArray *element = nil;
                foreach (element, result2)
                {
                    if ([[element oo_stringAtIndex:0] isEqualToString:[(NSArray*)vars oo_stringAtIndex:0]])
                    {
 
                        [result2 removeObject:element];
                        NSRange notTheHeader;
                        notTheHeader.location = 1;
                        notTheHeader.length = [(NSArray*)vars count]-1;
                        [result2 addObject:[element arrayByAddingObjectsFromArray:[(NSArray*)vars subarrayWithRange:notTheHeader]]];
                        found = YES;
                        break;
                    }
                }
                if (!found)
                {
                    [result2 addObject:vars];
                }
            }
        }
    }
    return [result1 arrayByAddingObjectsFromArray:result2];
}

missionTitle

- (NSString *) missionTitle

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return _missionTitle;
}

missionVariableForKey:

- (NSString *) missionVariableForKey:

(NSString *)

key

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                                   :(NSString *)key
{
    NSString *result = nil;
    if (key != nil)  result = [mission_variables objectForKey:key];
    return result;
}

Referenced by MissionVariablesGetProperty().

Here is the caller graph for this function:

missionVariables

- (NSDictionary *) missionVariables

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    return mission_variables;
}

mountMissile:

- (BOOL) mountMissile:

(ShipEntity *)

missile

Definition at line 13727 of file PlayerEntity.m.

                     :(ShipEntity *)missile
{
    if (missile == nil)  return NO;
    
    unsigned i;
    for (i = 0; i < max_missiles; i++)
    {
        if (missile_entity[i] == nil)
        {
            missile_entity[i] = [missile retain];
            missile_list[missiles] = [OOEquipmentType equipmentTypeWithIdentifier:[missile primaryRole]];
            missiles++;
            if (missiles == 1) [self setActiveMissile:0];   // auto select the first purchased missile
            return YES;
        }
    }
    
    return NO;
}

mountMissileWithRole:

- (BOOL) mountMissileWithRole:

(NSString *)

role

Definition at line 13727 of file PlayerEntity.m.

                             :(NSString *)role
{
    if ([self missileCount] >= [self missileCapacity]) return NO;
    return [self mountMissile:[[UNIVERSE newShipWithRole:role] autorelease]];
}

Referenced by ShipAwardEquipment().

Here is the caller graph for this function:

moveForward:

- (void) moveForward: (double)  amount

implementation

Reimplemented from Entity.

Definition at line 13727 of file PlayerEntity.m.

                    :(double) amount
{
    distanceTravelled += (float)amount;
    [self setPosition:HPvector_add(position, vectorToHPVector(vector_multiply_scalar(v_forward, (float)amount)))];
}

moveTargetMemoryBy:

- (BOOL) moveTargetMemoryBy:

(NSInteger)

delta

Definition at line 9242 of file PlayerEntity.m.

                           :(NSInteger)delta
{
    unsigned i = 0;
    while (i++ < PLAYER_TARGET_MEMORY_SIZE) // limit loops
    {
        NSInteger idx = (NSInteger)target_memory_index + delta;
        while (idx < 0)  idx += PLAYER_TARGET_MEMORY_SIZE;
        while (idx >= PLAYER_TARGET_MEMORY_SIZE) idx -= PLAYER_TARGET_MEMORY_SIZE;
        target_memory_index = idx;
 
        id targ_id = [target_memory objectAtIndex:target_memory_index];
        if ([targ_id isProxy])
        {
            ShipEntity *potential_target = [(OOWeakReference *)targ_id weakRefUnderlyingObject];
        
            if ((potential_target)&&(potential_target->isShip)&&([potential_target isInSpace]))
            {
                if (potential_target->zero_distance < SCANNER_MAX_RANGE2 && (![potential_target isCloaked]))
                {
                    [super addTarget:potential_target];
                    if (missile_status != MISSILE_STATUS_SAFE)
                    {
                        if( [missile_entity[activeMissile] isMissile])
                        {
                            [missile_entity[activeMissile] addTarget:potential_target];
                            missile_status = MISSILE_STATUS_TARGET_LOCKED;
                            [self printIdentLockedOnForMissile:YES];
                        }
                        else
                        {
                            missile_status = MISSILE_STATUS_ARMED;
                            [self playIdentLockedOn];
                            [self printIdentLockedOnForMissile:NO];
                        }
                    }
                    else
                    {
                        ident_engaged = YES;
                        [self printIdentLockedOnForMissile:NO];
                    }
                    [self playTargetSwitched];
                    return YES;
                }
            }
            else
            {
                [target_memory replaceObjectAtIndex:target_memory_index withObject:[NSNull null]];
            }
        }
    }
    
    [self playNoTargetInMemory];
    return NO;
}

multiFunctionDisplayList

- (NSArray *) multiFunctionDisplayList

Definition at line 13727 of file PlayerEntity.m.

{
    return multiFunctionDisplaySettings;
}

Referenced by PlayerShipGetProperty().

Here is the caller graph for this function:

multiFunctionText:

- (NSString *) multiFunctionText:

(NSUInteger)

index

Definition at line 13727 of file PlayerEntity.m.

                                :(NSUInteger)i
{
    NSString *key = [multiFunctionDisplaySettings oo_stringAtIndex:i defaultValue:nil];
    if (key == nil)
    {
        return nil;
    }
    NSString *text = [multiFunctionDisplayText oo_stringForKey:key defaultValue:nil];
    return text;
}

mungChecksumWithNSString:

- (void) mungChecksumWithNSString:

(NSString *)

str

Definition at line 9242 of file PlayerEntity.m.

                                 :(NSString *)str
{
    if (str == nil)  return;
    
    NSUInteger i, length = [str length];
    for (i = 0; i < length; i++)
    {
        munge_checksum([str characterAtIndex:i]);
    }
}

nativeSavePlayer:

- (void) nativeSavePlayer: (NSString *)  cdrName

implementation

Provided by category PlayerEntity(OOLoadSavePrivate).

Definition at line 1420 of file PlayerEntityLoadSave.m.

                        :(NSString *)cdrName
{
    NSString*   dir = [[UNIVERSE gameController] playerFileDirectory];
    NSString *savePath = [dir stringByAppendingPathComponent:[cdrName stringByAppendingPathExtension:@"oolite-save"]];
    
    ShipScriptEventNoCx(self, "playerWillSaveGame", OOJSSTR("STANDARD_SAVE"));
    
    [self setLastsaveName:cdrName];
    
    [self writePlayerToPath:savePath];
}

newShipCommonSetup:yardInfo:baseInfo:

- (void) newShipCommonSetup:		(NSString *)	shipKey
yardInfo:		(NSDictionary *)	ship_info
baseInfo:		(NSDictionary *)	ship_base_dict

Provided by category PlayerEntity(Contracts).

Definition at line 1443 of file PlayerEntityContracts.m.

                           :(NSString *)shipKey yardInfo:(NSDictionary *)ship_info baseInfo:(NSDictionary *)ship_base_dict 
{
    // Zero out our manifest.
    [shipCommodityData removeAllGoods];
    current_cargo = 0;
    
    // drop all passengers
    [passengers removeAllObjects];
    [passenger_record removeAllObjects]; 
        
    // parcels stay the same; easy to transfer between ships
    // contracts stay the same, so if you default - tough!
    // okay we need to switch the model used, lots of the stats, and add all the extras
    
    [self clearSubEntities];
 
    [self setShipDataKey:shipKey];
 
    NSDictionary *shipDict = ship_base_dict;
 
 
    // get a full tank for free
    [self setFuel:[self fuelCapacity]];
    
    // get forward_weapon aft_weapon port_weapon starboard_weapon from ship_info
    int base_facings = [shipDict oo_unsignedIntForKey:KEY_WEAPON_FACINGS defaultValue:15];
    int available_facings = [ship_info oo_unsignedIntForKey:KEY_WEAPON_FACINGS defaultValue:base_facings];
 
    // not retained - weapon types are references to the objects in OOEquipmentType's cache
    if (available_facings & WEAPON_FACING_AFT)
        aft_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy([shipDict oo_stringForKey:@"aft_weapon_type"]);
    else
        aft_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy(@"EQ_WEAPON_NONE");
 
    if (available_facings & WEAPON_FACING_PORT)
        port_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy([shipDict oo_stringForKey:@"port_weapon_type"]);
    else
        port_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy(@"EQ_WEAPON_NONE");
 
    if (available_facings & WEAPON_FACING_STARBOARD)
        starboard_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy([shipDict oo_stringForKey:@"starboard_weapon_type"]);
    else
        starboard_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy(@"EQ_WEAPON_NONE");
 
    if (available_facings & WEAPON_FACING_FORWARD)
        forward_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy([shipDict oo_stringForKey:@"forward_weapon_type"]);
    else
        forward_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy(@"EQ_WEAPON_NONE");
    
    // new ships start with weapons online
    weapons_online = 1;
 
    // get basic max_cargo
    max_cargo = [UNIVERSE maxCargoForShip:[self shipDataKey]];
 
    // ensure all missiles are tidied up and start at pylon 0
    [self tidyMissilePylons];
 
    // get missiles from ship_info
    missiles = [shipDict oo_unsignedIntForKey:@"missiles"];
    
    // reset max_passengers
    max_passengers = 0;
    
    // reset and refill extra_equipment then set flags from it
    
    // keep track of portable equipment..
 
    NSMutableSet    *portable_equipment = [NSMutableSet set];
    NSEnumerator    *eqEnum = nil;
    NSString        *eq_desc = nil;
    OOEquipmentType *item = nil;
    
    for (eqEnum = [self equipmentEnumerator]; (eq_desc = [eqEnum nextObject]);)
    {
        item = [OOEquipmentType equipmentTypeWithIdentifier:eq_desc];
        if ([item isPortableBetweenShips])  [portable_equipment addObject:eq_desc];
    }
    
    // remove ALL
    [self removeAllEquipment];
    
    // restore  portable equipment
    for (eqEnum = [portable_equipment objectEnumerator]; (eq_desc = [eqEnum nextObject]); )
    {
        [self addEquipmentItem:eq_desc withValidation:NO inContext:@"portable"];
    }
 
 
    // set up subentities from scratch; new ship could carry more or fewer than the old one
    [self setUpSubEntities];
 
    // clear old ship names
    [self setShipClassName:[shipDict oo_stringForKey:@"name"]];
    [self setShipUniqueName:@""];
 
    // new ship, so lose some memory of actions
    // new ship, so lose some memory of player actions
    if (ship_kills >= 6400)
    {
        [self clearRolesFromPlayer:0.1];
    }
    else if (ship_kills >= 2560)
    {
        [self clearRolesFromPlayer:0.25];
    }
    else
    {
        [self clearRolesFromPlayer:0.5];
    }   
 
}

nextHopTargetSystemID

- (OOSystemID) nextHopTargetSystemID

Definition at line 13727 of file PlayerEntity.m.

{
    // not available if no ANA
    if (![self hasEquipmentItemProviding:@"EQ_ADVANCED_NAVIGATIONAL_ARRAY"])
    {
        return target_system_id;
    }
    // not available if ANA is turned off
    if (ANA_mode == OPTIMIZED_BY_NONE)
    {
        return target_system_id;
    }
    // easy case
    if (system_id == target_system_id)
    {
        return system_id; // no need to calculate
    }
    NSDictionary *routeInfo = nil;
    routeInfo = [UNIVERSE routeFromSystem:system_id toSystem:target_system_id optimizedBy:ANA_mode];
    // no route to destination
    if (routeInfo == nil)
    {
        return target_system_id;
    }
    return [[routeInfo oo_arrayForKey:@"route"] oo_intAtIndex:1];
}

nextInfoSystem

- (void) nextInfoSystem

Definition at line 13727 of file PlayerEntity.m.

{
    if (ANA_mode == OPTIMIZED_BY_NONE)
    {
        [self setInfoSystemID: target_system_id moveChart: YES];
        return;
    }
    NSArray *route = [[[UNIVERSE routeFromSystem:system_id toSystem:target_system_id optimizedBy:ANA_mode] oo_arrayForKey: @"route"] retain];
    NSUInteger i;
    if (route == nil)
    {
        [self setInfoSystemID: target_system_id moveChart: YES];
        return;
    }
    for (i = 0; i < [route count]; i++)
    {
        if ([[route objectAtIndex: i] intValue] == info_system_id)
        {
            if (i + 1 < [route count])
            {
                [self setInfoSystemID:[[route objectAtIndex:i + 1] unsignedIntValue] moveChart: YES];
                [route release];
                return;
            }
            break;
        }
    }
    [route release];
    [self setInfoSystemID: target_system_id moveChart: YES];
    return;
}

normaliseReputation

- (void) normaliseReputation

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    int c_good = [reputation oo_intForKey:CONTRACTS_GOOD_KEY];
    int c_bad = [reputation oo_intForKey:CONTRACTS_BAD_KEY];
    int c_unknown = [reputation oo_intForKey:CONTRACTS_UNKNOWN_KEY];
    int p_good = [reputation oo_intForKey:PASSAGE_GOOD_KEY];
    int p_bad = [reputation oo_intForKey:PASSAGE_BAD_KEY];
    int p_unknown = [reputation oo_intForKey:PASSAGE_UNKNOWN_KEY];
    int pl_good = [reputation oo_intForKey:PARCEL_GOOD_KEY];
    int pl_bad = [reputation oo_intForKey:PARCEL_BAD_KEY];
    int pl_unknown = [reputation oo_intForKey:PARCEL_UNKNOWN_KEY];
 
    int c = c_good + c_bad + c_unknown;
    if (c == 0)
    {
        c_unknown = MAX_CONTRACT_REP;
    }
    else if (c != MAX_CONTRACT_REP)
    {
        c_good = c_good * MAX_CONTRACT_REP / c;
        c_bad = c_bad * MAX_CONTRACT_REP / c;
        c_unknown = MAX_CONTRACT_REP - c_good - c_bad;
    }
 
    int p = p_good + p_bad + p_unknown;
    if (p == 0)
    {
        p_unknown = MAX_CONTRACT_REP;
    }
    else if (p != MAX_CONTRACT_REP)
    {
        p_good = p_good * MAX_CONTRACT_REP / p;
        p_bad = p_bad * MAX_CONTRACT_REP / p;
        p_unknown = MAX_CONTRACT_REP - p_good - p_bad;
    }
    
    int pl = pl_good + pl_bad + pl_unknown;
    if (pl == 0)
    {
        pl_unknown = MAX_CONTRACT_REP;
    }
    else if (pl != MAX_CONTRACT_REP)
    {
        pl_good = pl_good * MAX_CONTRACT_REP / pl;
        pl_bad = pl_bad * MAX_CONTRACT_REP / pl;
        pl_unknown = MAX_CONTRACT_REP - pl_good - pl_bad;
    }
 
    [reputation setObject:[NSNumber numberWithInt:c_good]       forKey:CONTRACTS_GOOD_KEY];
    [reputation setObject:[NSNumber numberWithInt:c_bad]        forKey:CONTRACTS_BAD_KEY];
    [reputation setObject:[NSNumber numberWithInt:c_unknown]    forKey:CONTRACTS_UNKNOWN_KEY];
    [reputation setObject:[NSNumber numberWithInt:p_good]       forKey:PASSAGE_GOOD_KEY];
    [reputation setObject:[NSNumber numberWithInt:p_bad]        forKey:PASSAGE_BAD_KEY];
    [reputation setObject:[NSNumber numberWithInt:p_unknown]    forKey:PASSAGE_UNKNOWN_KEY];
    [reputation setObject:[NSNumber numberWithInt:pl_good]      forKey:PARCEL_GOOD_KEY];
    [reputation setObject:[NSNumber numberWithInt:pl_bad]       forKey:PARCEL_BAD_KEY];
    [reputation setObject:[NSNumber numberWithInt:pl_unknown]   forKey:PARCEL_UNKNOWN_KEY];
    
}

normalOrientation

- (Quaternion) normalOrientation

implementation

Reimplemented from Entity.

Definition at line 13727 of file PlayerEntity.m.

{
    return make_quaternion(-orientation.w, orientation.x, orientation.y, orientation.z);
}

noteCompassLostTarget

- (void) noteCompassLostTarget

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    if ([[self hud] isCompassActive])
    {
        // "the compass, it says we're lost!" :)
        JSContext *context = OOJSAcquireContext();
        jsval jsmode = OOJSValueFromCompassMode(context, [self compassMode]);
        ShipScriptEvent(context, self, "compassTargetChanged", JSVAL_VOID, jsmode);
        OOJSRelinquishContext(context);
        
        [[self hud] setCompassActive:NO];   // ensure a target change when returning to normal space.
    }
}

noteGUIDidChangeFrom:to:

- (void) noteGUIDidChangeFrom:		(OOGUIScreenID)	fromScreen
to:		(OOGUIScreenID)	toScreen

Definition at line 9242 of file PlayerEntity.m.

                             :(OOGUIScreenID)fromScreen to:(OOGUIScreenID)toScreen
{
    [self noteGUIDidChangeFrom: fromScreen to: toScreen refresh: NO];
}

noteGUIDidChangeFrom:to:refresh:

- (void) noteGUIDidChangeFrom:		(OOGUIScreenID)	fromScreen
to:		(OOGUIScreenID)	toScreen
refresh:		(BOOL)	refresh

Definition at line 9242 of file PlayerEntity.m.

                             :(OOGUIScreenID)fromScreen to:(OOGUIScreenID)toScreen refresh: (BOOL) refresh
{
    // No events triggered if we're changing screens while paused, or if screen never actually changed.
    if (fromScreen != toScreen || refresh)
    {
        // MKW - release GUI Screen ship, if we have one
        switch (fromScreen)
        {
            case GUI_SCREEN_SHIPYARD:
            case GUI_SCREEN_LOAD:
            case GUI_SCREEN_SAVE:
                [demoShip release];
                demoShip = nil;
                break;
            default:
                // Nothing
                break;
 
        }
        
        if (toScreen == GUI_SCREEN_SYSTEM_DATA)
        {
            // system data screen: ensure correct sun light color is used on miniature planet
            [[UNIVERSE sun] setSunColor:[OOColor colorWithDescription:[[UNIVERSE systemManager] getProperty:@"sun_color" forSystem:info_system_id inGalaxy:[self galaxyNumber]]]];
        }
        else
        {
            // any other screen: reset local sun light color
            [[UNIVERSE sun] setSunColor:[OOColor colorWithDescription:[[UNIVERSE systemManager] getProperty:@"sun_color" forSystem:system_id inGalaxy:[self galaxyNumber]]]];
        }
        
        if (![[UNIVERSE gameController] isGamePaused])
        {
            JSContext *context = OOJSAcquireContext();
            ShipScriptEvent(context, self, "guiScreenChanged", OOJSValueFromGUIScreenID(context, toScreen), OOJSValueFromGUIScreenID(context, fromScreen));
            OOJSRelinquishContext(context);
        }
    }
}

noteGUIWillChangeTo:

- (void) noteGUIWillChangeTo:

(OOGUIScreenID)

toScreen

Definition at line 9242 of file PlayerEntity.m.

                            :(OOGUIScreenID)toScreen
{
    JSContext *context = OOJSAcquireContext();
    ShipScriptEvent(context, self, "guiScreenWillChange", OOJSValueFromGUIScreenID(context, toScreen), OOJSValueFromGUIScreenID(context, gui_screen));
    OOJSRelinquishContext(context);
}

noteSwitchToView:fromView:

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

Provided by category PlayerEntity(Controls).

Definition at line 164 of file PlayerEntityControls.m.

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

Referenced by PlayerShipResetCustomView(), and PlayerShipSetCustomView().

Here is the caller graph for this function:

noteViewDidChangeFrom:toView:

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

Definition at line 9242 of file PlayerEntity.m.

                              :(OOViewID)fromView toView:(OOViewID)toView
{
    [self noteSwitchToView:toView fromView:fromView];
}

noticeECM

- (void) noticeECM

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    last_ecm_time = [UNIVERSE getTime];
}

occlusionLevel

- (float) occlusionLevel

Definition at line 13727 of file PlayerEntity.m.

{
    return occlusion_dial;
}

oo_jsClassName

- (NSString *) oo_jsClassName

implementation

Reimplemented from ShipEntity.

Provided by category PlayerEntity(OOJavaScriptExtensions).

Definition at line 1860 of file OOJSPlayerShip.m.

{
    return @"PlayerShip";
}

orientationChanged

- (void) orientationChanged

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    quaternion_normalize(&orientation);
    rotMatrix = OOMatrixForQuaternionRotation(orientation);
    OOMatrixGetBasisVectors(rotMatrix, &v_right, &v_up, &v_forward);
    
    orientation.w = -orientation.w;
    playerRotMatrix = OOMatrixForQuaternionRotation(orientation);   // this is the rotation similar to ordinary ships
    orientation.w = -orientation.w;
}

outputKeyDefinition:shift:mod1:mod2:skiprows:

- (void) outputKeyDefinition:		(NSString *)	key
shift:		(NSString *)	shift
mod1:		(NSString *)	mod1
mod2:		(NSString *)	mod2
skiprows:		(NSUInteger)	skiprows

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                            :(NSString *)key shift:(NSString *)shift mod1:(NSString *)mod1 mod2:(NSString *)mod2 skiprows:(NSUInteger)skiprows
{
    GuiDisplayGen *gui=[UNIVERSE gui];
 
    [gui setArray:[NSArray arrayWithObjects: 
                                (skiprows == 0 ? DESC(@"oolite-keyconfig-update-key") : DESC(@"oolite-keyconfig-update-alternate")), key, nil]
                    forRow:GUI_ROW_KC_KEY + skiprows];
    [gui setKey:GUI_KEY_OK forRow:GUI_ROW_KC_KEY + skiprows];
 
    if (![nav_keys containsObject:[selected_entry objectForKey: KEY_KC_DEFINITION]]) {
        if (![key isEqualToString:DESC(@"oolite-keycode-unset")])
        {
            [gui setArray:[NSArray arrayWithObjects: 
                                        DESC(@"oolite-keyconfig-update-shift"), shift, nil]
                            forRow:GUI_ROW_KC_SHIFT + skiprows];
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW_KC_SHIFT + skiprows];
 
            // camera movement keys can't use ctrl
            if (![camera_keys containsObject:[selected_entry objectForKey: KEY_KC_DEFINITION]]) {
                [gui setArray:[NSArray arrayWithObjects: 
                                            DESC(@"oolite-keyconfig-update-mod1"), mod1, nil]
                                forRow:GUI_ROW_KC_MOD1 + skiprows];
                [gui setKey:GUI_KEY_OK forRow:GUI_ROW_KC_MOD1 + skiprows];
            } 
            else 
            {
                [gui setArray:[NSArray arrayWithObjects: 
                                            DESC(@"oolite-keyconfig-update-mod1"), DESC(@"not-applicable"), nil]
                                forRow:GUI_ROW_KC_MOD1 + skiprows];
            }
                    
#if OOLITE_MAC_OS_X
            [gui setArray:[NSArray arrayWithObjects: 
                                        DESC(@"oolite-keyconfig-update-mod2-mac"), mod2, nil]
                            forRow:GUI_ROW_KC_MOD2 + skiprows];
#else
            [gui setArray:[NSArray arrayWithObjects: 
                                        DESC(@"oolite-keyconfig-update-mod2-pc"), mod2, nil]
                            forRow: GUI_ROW_KC_MOD2 + skiprows];
#endif
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW_KC_MOD2 + skiprows];
        }
    }
}

overwriteCommanderInputHandler

- (void) overwriteCommanderInputHandler

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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:@""];
    }
}

parcelContractMarker:

- (NSDictionary *) parcelContractMarker:

(OOSystemID)

system

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                       :(OOSystemID)system
{
    return [[[NSDictionary dictionaryWithObjectsAndKeys:
                                [NSNumber numberWithInt:system], @"system",
                                MISSION_DEST_LEGACY, @"name",
                                @"orangeColor", @"markerColor",
                                @"MARKER_PLUS", @"markerShape",
                                nil] retain] autorelease];
}

parcelCount

- (NSUInteger) parcelCount

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

{
    return [parcels count];
}

Referenced by PlayerShipRemoveParcel().

Here is the caller graph for this function:

parcelList

- (NSArray *) parcelList

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    return [self contractsListFromArray:parcels forCargo:NO forParcels:YES];
}

parcelListForScripting

- (NSArray *) parcelListForScripting

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    return [self contractsListForScriptingFromArray:parcels forCargo:NO];
}

parcelReputation

- (int) parcelReputation

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    int good = [reputation oo_intForKey:PARCEL_GOOD_KEY];
    int bad = [reputation oo_intForKey:PARCEL_BAD_KEY];
    int unknown = [reputation oo_intForKey:PARCEL_UNKNOWN_KEY];
    
    if (unknown > 0)
        unknown = MAX_CONTRACT_REP - (((2*unknown)+(market_rnd % unknown))/3);
    else
        unknown = MAX_CONTRACT_REP;
    
    return (good + unknown - 3 * bad) / 2;  // return a number from -MAX_CONTRACT_REP to +MAX_CONTRACT_REP
}

passengerCapacity

- (NSUInteger) passengerCapacity

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

{
    return max_passengers;
}

passengerContractMarker:

- (NSDictionary *) passengerContractMarker:

(OOSystemID)

system

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                          :(OOSystemID)system
{
    return [[[NSDictionary dictionaryWithObjectsAndKeys:
                                [NSNumber numberWithInt:system], @"system",
                                MISSION_DEST_LEGACY, @"name",
                                @"orangeColor", @"markerColor",
                                @"MARKER_DIAMOND", @"markerShape",
                                nil] retain] autorelease];
}

passengerCount

- (NSUInteger) passengerCount

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

{
    return [passengers count];
}

Referenced by PlayerShipRemovePassenger().

Here is the caller graph for this function:

passengerList

- (NSArray *) passengerList

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    return [self contractsListFromArray:passengers forCargo:NO forParcels:NO];
}

passengerListForScripting

- (NSArray *) passengerListForScripting

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    return [self contractsListForScriptingFromArray:passengers forCargo:NO];
}

passengerReputation

- (int) passengerReputation

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    int good = [reputation oo_intForKey:PASSAGE_GOOD_KEY];
    int bad = [reputation oo_intForKey:PASSAGE_BAD_KEY];
    int unknown = [reputation oo_intForKey:PASSAGE_UNKNOWN_KEY];
 
    if (unknown > 0)
        unknown = MAX_CONTRACT_REP - (((2*unknown)+(market_rnd % unknown))/3);
    else
        unknown = MAX_CONTRACT_REP;
    
    return (good + unknown - 3 * bad) / 2;  // return a number from -MAX_CONTRACT_REP to +MAX_CONTRACT_REP
}

penaltyForUnauthorizedDocking

- (void) penaltyForUnauthorizedDocking

Definition at line 9242 of file PlayerEntity.m.

{
    OOCreditsQuantity   amountToPay = 0;
    OOCreditsQuantity   calculatedFine = credits * 0.05;
    OOCreditsQuantity   maximumFine = 50000ULL;
    
    if ([self clearedToDock])
        return;
        
    amountToPay = MIN(maximumFine, calculatedFine);
    credits -= amountToPay;
    [self addMessageToReport:[NSString stringWithFormat:DESC(@"station-docking-clearance-fined-@-cr"), OOCredits(amountToPay)]];
}

PerformActionStatment

+ (static void) PerformActionStatment (NSArray *)  statement (Entity *)  target

implementation

Provided by category PlayerEntity(Scripting).

Definition at line 185 of file PlayerEntityLegacyScriptEngine.m.

{
    /*  A sanitized action statement takes the form of an array:
        (false, selector [, argument])
        The first element is always false. The second is the method selector
        (as a string). If the method takes an argument, the third argument is
        the argument string.
 
        The sanitizer is responsible for ensuring that there is an argument,
        even if it's the empty string, for any selector with a colon at the
        end, and no arguments for selectors without colons. The runner can
        therefore use the list's element count as a flag without examining the
        selector.
    */
    
    NSString                *selectorString = nil;
    NSString                *argumentString = nil;
    NSString                *expandedString = nil;
    SEL                     selector = NULL;
    NSMutableDictionary     *locals = nil;
    PlayerEntity            *player = PLAYER;
    
    selectorString = [statement objectAtIndex:1];
    if ([statement count] > 2)  argumentString = [statement objectAtIndex:2];
    
    selector = NSSelectorFromString(selectorString);
    
    if (target == nil || ![target respondsToSelector:selector])
    {
        target = player;
    }
    
    if (argumentString != nil)
    {
        // Method with argument; substitute [description] expressions.
        locals = [player localVariablesForMission:sCurrentMissionKey];
        expandedString = OOExpandDescriptionString(OOStringExpanderDefaultRandomSeed(), argumentString, nil, locals, nil, kOOExpandNoOptions);
        
        [target performSelector:selector withObject:expandedString];
    }
    else
    {
        // Method without argument.
        [target performSelector:selector];
    }
}

performAutopilotUpdates:

- (void) performAutopilotUpdates: (OOTimeDelta)  delta_t

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                                :(OOTimeDelta)delta_t
{
    [self processBehaviour:delta_t];
    [self applyVelocity:delta_t];
    [self doBookkeeping:delta_t];
}

PerformConditionalStatment

+ (static void) PerformConditionalStatment (NSArray *)  actions (Entity *)  target

implementation

Provided by category PlayerEntity(Scripting).

Definition at line 158 of file PlayerEntityLegacyScriptEngine.m.

{
    /*  A sanitized conditional statement takes the form of an array:
        (true, conditions, trueActions, falseActions)
        The first element is always true. The second is an array of conditions.
        The third and four elements are actions to perform if the conditions
        evaluate to true or false, respectively.
    */
    
    NSArray             *conditions = nil;
    NSArray             *actions = nil;
    
    conditions = [statement objectAtIndex:1];
    
    if (TestScriptConditions(conditions))
    {
        actions = [statement objectAtIndex:2];
    }
    else
    {
        actions = [statement objectAtIndex:3];
    }
    
    PerformScriptActions(actions, target);
}

performDeadUpdates:

- (void) performDeadUpdates: (OOTimeDelta)  delta_t

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                           :(OOTimeDelta)delta_t
{
    [UNIVERSE terminatePostFX:OO_POSTFX_CLOAK];
    if ([UNIVERSE ECMVisualFXEnabled])  [UNIVERSE terminatePostFX:OO_POSTFX_CRTBADSIGNAL];
    
    [self gameOverFadeToBW];
    
    if ([self shotTime] > kDeadResetTime)
    {
        BOOL was_mouse_control_on = mouse_control_on;
        [UNIVERSE handleGameOver];              //  we restart the UNIVERSE
        mouse_control_on = was_mouse_control_on;
    }
}

performDockingRequest:

- (void) performDockingRequest:

(StationEntity *)

stationForDocking

Definition at line 13727 of file PlayerEntity.m.

                              :(StationEntity *)stationForDocking
{
    if (stationForDocking == nil) return;
    if (![stationForDocking isStation] || ![stationForDocking isKindOfClass:[StationEntity class]]) return;
    if ([self isDocked])  return;
    if (autopilot_engaged && [self targetStation] == stationForDocking) return;
    if (autopilot_engaged && [self targetStation] != stationForDocking)
    {
        [self disengageAutopilot];
    }
    NSString *stationDockingClearanceStatus = [stationForDocking acceptDockingClearanceRequestFrom:self];
    if (stationDockingClearanceStatus != nil)
    {
        [self doScriptEvent:OOJSID("playerRequestedDockingClearance") withArgument:stationDockingClearanceStatus];
        if ([stationDockingClearanceStatus isEqualToString:@"DOCKING_CLEARANCE_GRANTED"]) 
        {
            [self doScriptEvent:OOJSID("playerDockingClearanceGranted")];
        }
    } 
}

performDockingUpdates:

- (void) performDockingUpdates: (OOTimeDelta)  delta_t

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                              :(OOTimeDelta)delta_t
{
    if ([UNIVERSE breakPatternOver])
    {
        [self docked];      // bookkeeping for docking
    }
 
    // if cloak or ecm visual effects are playing while docking, terminate them
    [UNIVERSE terminatePostFX:OO_POSTFX_CLOAK];
    if ([UNIVERSE ECMVisualFXEnabled])  [UNIVERSE terminatePostFX:OO_POSTFX_CRTBADSIGNAL];
}

performInFlightUpdates:

- (void) performInFlightUpdates: (OOTimeDelta)  delta_t

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                               :(OOTimeDelta)delta_t
{
    STAGE_TRACKING_BEGIN
    
    // do flight routines
    UPDATE_STAGE(@"applying newtonian drift");
    assert(VELOCITY_CLEANUP_FULL > VELOCITY_CLEANUP_MIN);
    
    [self applyVelocity:delta_t];
    
    GLfloat thrust_factor = 1.0;
    if (flightSpeed > maxFlightSpeed)
    {
        if (afterburner_engaged)
        {
            thrust_factor = [self afterburnerFactor];
        }
        else
        {
            thrust_factor = HYPERSPEED_FACTOR;
        }
    }
    
 
    GLfloat velmag = magnitude(velocity);
    GLfloat velmag2 = velmag - (float)delta_t * thrust * thrust_factor;
    if (velmag > 0)
    {
        UPDATE_STAGE(@"applying power braking");
        
        if (velmag > VELOCITY_CLEANUP_MIN)
        {
            GLfloat rate;
            // Fix up extremely ridiculous speeds that can happen in collisions or explosions
            if (velmag > VELOCITY_CLEANUP_FULL)  rate = VELOCITY_CLEANUP_RATE;
            else  rate = (velmag - VELOCITY_CLEANUP_MIN) / (VELOCITY_CLEANUP_FULL - VELOCITY_CLEANUP_MIN) * VELOCITY_CLEANUP_RATE;
            velmag2 -= velmag * rate;
        }
        if (velmag2 < 0.0f)  velocity = kZeroVector;
        else  velocity = vector_multiply_scalar(velocity, velmag2 / velmag);
        
    }
    
    UPDATE_STAGE(@"updating joystick");
    [self applyRoll:(float)delta_t*flightRoll andClimb:(float)delta_t*flightPitch];
    if (flightYaw != 0.0)
    {
        [self applyYaw:(float)delta_t*flightYaw];
    }
    
    UPDATE_STAGE(@"applying para-newtonian thrust");
    [self moveForward:delta_t*flightSpeed];
    
    UPDATE_STAGE(@"updating targeting");
    [self updateTargeting];
    
    STAGE_TRACKING_END
}

performLaunchingUpdates:

- (void) performLaunchingUpdates: (OOTimeDelta)  delta_t

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                                :(OOTimeDelta)delta_t
{
    if (![UNIVERSE breakPatternHide])
    {
        flightRoll = launchRoll;    // synchronise player's & launching station's spins.
        [self doBookkeeping:delta_t];   // don't show ghost exhaust plumes from previous docking!
    }
    
    if ([UNIVERSE breakPatternOver])
    {
        // time to check the legacy scripts!
        [self checkScript];
        // next check in 10s
        
        [self setStatus:STATUS_IN_FLIGHT];
 
        [self setDockingClearanceStatus:DOCKING_CLEARANCE_STATUS_NONE];
        StationEntity *stationLaunchedFrom = [UNIVERSE nearestEntityMatchingPredicate:IsStationPredicate parameter:NULL relativeToEntity:self];
        [self doScriptEvent:OOJSID("shipLaunchedFromStation") withArgument:stationLaunchedFrom];
    }
}

PerformScriptActions

+ (static void) PerformScriptActions (NSArray *)  actions (Entity *)  target

implementation

Provided by category PlayerEntity(Scripting).

Definition at line 141 of file PlayerEntityLegacyScriptEngine.m.

{
    NSArray *statement = nil;
    foreach (statement, actions)
    {
        if ([[statement objectAtIndex:0] boolValue])
        {
            PerformConditionalStatment(statement, target);
        }
        else
        {
            PerformActionStatment(statement, target);
        }
    }
}

performWitchspaceCountdownUpdates:

- (void) performWitchspaceCountdownUpdates: (OOTimeDelta)  delta_t

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                                          :(OOTimeDelta)delta_t
{
    STAGE_TRACKING_BEGIN
    
    UPDATE_STAGE(@"doing bookkeeping");
    [self doBookkeeping:delta_t];
    
    UPDATE_STAGE(@"updating countdown timer");
    witchspaceCountdown = fdim(witchspaceCountdown, delta_t);
    
    // damaged gal drive? abort!
    /* TODO: this check should possibly be hasEquipmentItemProviding:,
     * but if it was we'd need to know which item was actually doing
     * the providing so it could be removed. */
    if (EXPECT_NOT(galactic_witchjump && ![self hasEquipmentItem:@"EQ_GAL_DRIVE"]))
    {
        galactic_witchjump = NO;
        [self setStatus:STATUS_IN_FLIGHT];
        [self playHyperspaceAborted];
        ShipScriptEventNoCx(self, "playerJumpFailed", OOJSSTR("malfunction"));
        return;
    }
    
    int seconds = round(witchspaceCountdown);
    if (galactic_witchjump)
    {
        [UNIVERSE displayCountdownMessage:OOExpandKey(@"witch-galactic-in-x-seconds", seconds) forCount:1.0];
    }
    else
    {
        NSString *destination = [UNIVERSE getSystemName:[self nextHopTargetSystemID]];
        [UNIVERSE displayCountdownMessage:OOExpandKey(@"witch-to-x-in-y-seconds", seconds, destination) forCount:1.0];
    }
    
    if (witchspaceCountdown == 0.0)
    {
        UPDATE_STAGE(@"preloading planet textures");
        if (!galactic_witchjump)
        {
            /*  Note: planet texture preloading is done twice for hyperspace jumps:
                once when starting the countdown and once at the beginning of the
                jump. The reason is that the preloading may have been skipped the
                first time because of rate limiting (see notes at
                -preloadPlanetTexturesForSystem:). There is no significant overhead
                from doing it twice thanks to the texture cache.
                -- Ahruman 2009-12-19
            */
            [UNIVERSE preloadPlanetTexturesForSystem:target_system_id];
        }
        else
        {
            // FIXME: preload target system for galactic jump?
        }
 
        UPDATE_STAGE(@"JUMP!");
        if (galactic_witchjump)  [self enterGalacticWitchspace];
        else  [self enterWitchspace];
        galactic_witchjump = NO;
    }
    
    STAGE_TRACKING_END
}

performWitchspaceExitUpdates:

- (void) performWitchspaceExitUpdates: (OOTimeDelta)  delta_t

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                                     :(OOTimeDelta)delta_t
{
    if ([UNIVERSE breakPatternOver])
    {
        [self resetExhaustPlumes];
        // time to check the script!
        [self checkScript];
        // next check in 10s
        [self resetScriptTimer];    // reset the in-system timer
        
        // announce arrival
        if ([UNIVERSE planet])
        {
            [UNIVERSE addMessage:[NSString stringWithFormat:@" %@. ",[UNIVERSE getSystemName:system_id]] forCount:3.0];
            // and reset the compass
            if ([self hasEquipmentItemProviding:@"EQ_ADVANCED_COMPASS"])
                compassMode = COMPASS_MODE_PLANET;
            else
                compassMode = COMPASS_MODE_BASIC;
        }
        else
        {
            if ([UNIVERSE inInterstellarSpace])  [UNIVERSE addMessage:DESC(@"witch-engine-malfunction") forCount:3.0]; // if sun gone nova, print nothing
        }
        
        [self setStatus:STATUS_IN_FLIGHT];
        
        // If we are exiting witchspace after a scripted misjump. then make sure it gets reset now.
        // Scripted misjump situations should have a lifespan of one jump only, to keep things
        // simple - Nikos 20090728
        if ([self scriptedMisjump])  [self setScriptedMisjump:NO];
        // similarly reset the misjump range to the traditional 0.5
        [self setScriptedMisjumpRange:0.5];
 
        [self doScriptEvent:OOJSID("shipExitedWitchspace") withArgument:[self jumpCause]];
 
        [self doBookkeeping:delta_t]; // arrival frame updates
 
        suppressAegisMessages=NO;
    }
}

planet_number

- (NSNumber *) planet_number

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:[self currentSystemID]];
}

playAegisCloseToPlanet

- (void) playAegisCloseToPlanet

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sMiscSoundPool playSoundWithKey:@"[aegis-planet]" position:kInterfaceBeepPosition];
}

playAegisCloseToStation

- (void) playAegisCloseToStation

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sMiscSoundPool playSoundWithKey:@"[aegis-station]" position:kInterfaceBeepPosition];
}

playAlertConditionRed

- (void) playAlertConditionRed

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sWarningSoundPool playSoundWithKey:@"[alert-condition-red]" priority:2 position:kInterfaceWarningPosition];
}

playAutopilotCannotDockWithTarget

- (void) playAutopilotCannotDockWithTarget

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[autopilot-cannot-dock-with-target]"];
}

playAutopilotOff

- (void) playAutopilotOff

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    // only if still alive
    if (energy > 0.0)
    {
        [self playInterfaceBeep:@"[autopilot-off]"];
    }
}

playAutopilotOn

- (void) playAutopilotOn

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[autopilot-on]"];
}

playAutopilotOutOfRange

- (void) playAutopilotOutOfRange

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[autopilot-out-of-range]"];
}

playBuyCommodity

- (void) playBuyCommodity

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sBuySellSourcePool playSoundWithKey:@"[buy-commodity]"];
}

playBuyShip

- (void) playBuyShip

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sBuySellSourcePool playSoundWithKey:@"[buy-ship]"];
}

playCantBuyCommodity

- (void) playCantBuyCommodity

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sBuySellSourcePool playSoundWithKey:@"[could-not-buy-commodity]"];
}

playCantBuyShip

- (void) playCantBuyShip

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sBuySellSourcePool playSoundWithKey:@"[could-not-buy-ship]"];
}

playCantSellCommodity

- (void) playCantSellCommodity

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sBuySellSourcePool playSoundWithKey:@"[could-not-sell-commodity]"];
}

playCargoJettisioned

- (void) playCargoJettisioned

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[cargo-jettisoned]"];
}

playChangedOption

- (void) playChangedOption

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[changed-option]"];
}

playCloakingDeviceInsufficientEnergy

- (void) playCloakingDeviceInsufficientEnergy

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[cloaking-device-insufficent-energy]"];
}

playCloakingDeviceOff

- (void) playCloakingDeviceOff

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[cloaking-device-off]"];
}

playCloakingDeviceOn

- (void) playCloakingDeviceOn

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[cloaking-device-on]"];
}

playDirectHit:weaponIdentifier:

- (void) playDirectHit:		(Vector)	attackVector
weaponIdentifier:		(NSString *)	weaponIdentifier

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                      :(Vector)attackVector weaponIdentifier:(NSString *) weaponIdentifier
{
    NSString *identifier = [weaponUnshieldedHit objectForKey:weaponIdentifier];
    if (!identifier)  identifier = @"[player-direct-hit]";
    [sDamageSoundPool playSoundWithKey:identifier position:attackVector];
}

playDismissedMissionScreen

- (void) playDismissedMissionScreen

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[dismissed-mission-screen]"];
}

playDismissedReportScreen

- (void) playDismissedReportScreen

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[dismissed-report-screen]"];
}

playDockingDenied

- (void) playDockingDenied

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sWarningSoundPool playSoundWithKey:@"[autopilot-denied]" priority:1 position:kInterfaceWarningPosition];
}

playDockWithStation

- (void) playDockWithStation

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sBreakPatternSource playCustomSoundWithKey:@"[player-dock-with-station]"];
}

playEnergyLow

- (void) playEnergyLow

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sWarningSoundPool playSoundWithKey:@"[energy-low]" priority:0.5 position:kInterfaceWarningPosition];
}

playEscapePodScooped

- (void) playEscapePodScooped

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sMiscSoundPool playSoundWithKey:@"[escape-pod-scooped]" position:kInterfaceBeepPosition];
}

playExitWitchspace

- (void) playExitWitchspace

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sBreakPatternSource playCustomSoundWithKey:@"[player-exit-witchspace]"];
}

playFiredECMSound

- (void) playFiredECMSound

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    if (![sEcmSource isPlaying]) [sEcmSource playCustomSoundWithKey:@"[player-fired-ecm]"];
}

playFuelLeak

- (void) playFuelLeak

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sWarningSoundPool playSoundWithKey:@"[fuel-leak]" priority:0.5 position:kWitchspacePosition];
}

playGalacticHyperspace

- (void) playGalacticHyperspace

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sHyperspaceSoundSource playCustomSoundWithKey:@"[galactic-hyperspace-countdown-begun]"];
}

Referenced by PlayerShipBeginGalacticHyperspaceCountdown().

Here is the caller graph for this function:

playGameOver

- (void) playGameOver

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sMiscSoundPool playSoundWithKey:@"[game-over]"];
}

playHitByECMSound

- (void) playHitByECMSound

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    if (![sEcmSource isPlaying]) [sEcmSource playCustomSoundWithKey:@"[player-hit-by-ecm]"];
}

playHoldFull

- (void) playHoldFull

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[hold-full]"];
}

playHostileWarning

- (void) playHostileWarning

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sWarningSoundPool playSoundWithKey:@"[hostile-warning]" priority:1 position:kInterfaceWarningPosition];
}

playHyperspaceAborted

- (void) playHyperspaceAborted

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sHyperspaceSoundSource playCustomSoundWithKey:@"[hyperspace-countdown-aborted]"];
}

playHyperspaceBlocked

- (void) playHyperspaceBlocked

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[hyperspace-blocked]"];
}

playHyperspaceDistanceTooGreat

- (void) playHyperspaceDistanceTooGreat

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[witch-too-far]"];
}

playHyperspaceNoFuel

- (void) playHyperspaceNoFuel

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[witch-no-fuel]"];
}

playHyperspaceNoTarget

- (void) playHyperspaceNoTarget

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[witch-no-target]"];
}

playIdentLockedOn

- (void) playIdentLockedOn

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[ident-locked-on]"];
}

playIdentOff

- (void) playIdentOff

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[ident-off]"];
}

playIdentOn

- (void) playIdentOn

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[ident-on]"];
}

playIncomingMissile:

- (void) playIncomingMissile:

(Vector)

missileVector

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                            :(Vector)missileVector
{
    [sWarningSoundPool playSoundWithKey:@"[incoming-missile]" priority:3 position:missileVector];
}

playInterfaceBeep:

- (void) playInterfaceBeep: (NSString *)  beepKey

implementation

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                          :(NSString *)beepKey
{
#if OOLITE_WINDOWS
    if ([self status] == STATUS_START_GAME) { return; }
#endif
    [sInterfaceBeepSource playSound:[OOSound soundWithCustomSoundKey:beepKey]];
}

playJumpMassLocked

- (void) playJumpMassLocked

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[jump-mass-locked]"];
}

playLaserHit:offset:weaponIdentifier:

- (void) playLaserHit:		(BOOL)	hit
offset:		(Vector)	weaponOffset
weaponIdentifier:		(NSString *)	weaponIdentifier

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                     :(BOOL)hit offset:(Vector)weaponOffset weaponIdentifier:(NSString *)weaponIdentifier
{
    NSString *identifier = nil;
    if (hit)
    {
        identifier = [weaponShotHit objectForKey:weaponIdentifier];
        if (!identifier)  identifier = @"[player-laser-hit]";
        [sWeaponSoundPool playSoundWithKey:identifier priority:1.0 expiryTime:0.05 overlap:YES position:weaponOffset];
    }
    else
    {
        identifier = [weaponShotMiss objectForKey:weaponIdentifier];
        if (!identifier)  identifier = @"[player-laser-miss]";
        [sWeaponSoundPool playSoundWithKey:identifier priority:1.0 expiryTime:0.05 overlap:YES position:weaponOffset];
 
    }
}

playLaunchFromStation

- (void) playLaunchFromStation

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sBreakPatternSource playCustomSoundWithKey:@"[player-launch-from-station]"];
}

playLegacyScriptSound:

- (void) playLegacyScriptSound:

(NSString *)

key

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                              :(NSString *)key
{
    [sMiscSoundPool playSoundWithKey:key priority:1.1];
}

playMenuNavigationDown

- (void) playMenuNavigationDown

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[menu-navigation-down]"];
}

playMenuNavigationNot

- (void) playMenuNavigationNot

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[menu-navigation-not]"];
}

playMenuNavigationUp

- (void) playMenuNavigationUp

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[menu-navigation-up]"];
}

playMenuPageNext

- (void) playMenuPageNext

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[menu-previous-page]"];
}

playMenuPagePrevious

- (void) playMenuPagePrevious

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[menu-next-page]"];
}

playMineArmed

- (void) playMineArmed

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[mine-armed]"];
}

playMineLaunched:weaponIdentifier:

- (void) playMineLaunched:		(Vector)	weaponOffset
weaponIdentifier:		(NSString *)	weaponIdentifier

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                         :(Vector)weaponOffset weaponIdentifier:(NSString *)weaponIdentifier
{
    NSString *identifier = [weaponLaunched objectForKey:weaponIdentifier];
    if (!identifier)  identifier = @"[mine_launched]";
    [sWeaponSoundPool playSoundWithKey:identifier position:weaponOffset];
}

playMissileArmed

- (void) playMissileArmed

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[missile-armed]"];
}

playMissileLaunched:weaponIdentifier:

- (void) playMissileLaunched:		(Vector)	weaponOffset
weaponIdentifier:		(NSString *)	weaponIdentifier

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                            :(Vector)weaponOffset weaponIdentifier:(NSString *)weaponIdentifier
{
    NSString *identifier = [weaponLaunched objectForKey:weaponIdentifier];
    if (!identifier)  identifier = @"[missile_launched]";
    [sWeaponSoundPool playSoundWithKey:identifier position:weaponOffset];
}

playMissileLockedOn

- (void) playMissileLockedOn

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[missile-locked-on]"];
}

playMissileSafe

- (void) playMissileSafe

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[missile-safe]"];
}

playNextEquipmentSelected

- (void) playNextEquipmentSelected

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[next-equipment-selected]"];
}

playNextMissileSelected

- (void) playNextMissileSelected

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[next-missile-selected]"];
}

playNoTargetInMemory

- (void) playNoTargetInMemory

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[no-target-in-memory]"];
}

playSaveOverwriteNo

- (void) playSaveOverwriteNo

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[save-overwrite-no]"];
}

playSaveOverwriteYes

- (void) playSaveOverwriteYes

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[save-overwrite-yes]"];
}

playScrapeDamage:

- (void) playScrapeDamage:

(Vector)

attackVector

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                         :(Vector)attackVector
{
    [sDamageSoundPool playSoundWithKey:@"[player-scrape-damage]" position:attackVector];
}

playSellCommodity

- (void) playSellCommodity

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sBuySellSourcePool playSoundWithKey:@"[sell-commodity]"];
}

playShieldHit:weaponIdentifier:

- (void) playShieldHit:		(Vector)	attackVector
weaponIdentifier:		(NSString *)	weaponIdentifier

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                      :(Vector)attackVector weaponIdentifier:(NSString *)weaponIdentifier
{
    NSString *identifier = [weaponShieldHit objectForKey:weaponIdentifier];
    if (!identifier)  identifier = @"[player-hit-by-weapon]";
    [sDamageSoundPool playSoundWithKey:identifier position:attackVector];
}

playSound:

- (void) playSound:

(NSString *)

soundName

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *) soundName
{
    [self playLegacyScriptSound:soundName];
}

playStandardHyperspace

- (void) playStandardHyperspace

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sHyperspaceSoundSource playCustomSoundWithKey:@"[hyperspace-countdown-begun]"];
}

playTargetLost

- (void) playTargetLost

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[target-lost]"];
}

playTargetSwitched

- (void) playTargetSwitched

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[target-switched]"];
}

playWeaponOverheated:

- (void) playWeaponOverheated:

(Vector)

weaponOffset

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                             :(Vector)weaponOffset
{
    [sWeaponSoundPool playSoundWithKey:@"[weapon-overheat]" overlap:NO position:weaponOffset];
}

playWeaponsOffline

- (void) playWeaponsOffline

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[weapons-offline]"];
}

playWeaponsOnline

- (void) playWeaponsOnline

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self playInterfaceBeep:@"[weapons-online]"];
}

playWitchjumpBlocked

- (void) playWitchjumpBlocked

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sWarningSoundPool playSoundWithKey:@"[witch-blocked-by-@]" priority:1.3 position:kWitchspacePosition];
}

playWitchjumpDistanceTooGreat

- (void) playWitchjumpDistanceTooGreat

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sWarningSoundPool playSoundWithKey:@"[witch-too-far]" priority:1.3 position:kWitchspacePosition];
}

playWitchjumpFailure

- (void) playWitchjumpFailure

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sWarningSoundPool playSoundWithKey:@"[witchdrive-failure]" priority:1.5 position:kWitchspacePosition];
}

playWitchjumpInsufficientFuel

- (void) playWitchjumpInsufficientFuel

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sWarningSoundPool playSoundWithKey:@"[witch-no-fuel]" priority:1.3 position:kWitchspacePosition];
}

playWitchjumpMisjump

- (void) playWitchjumpMisjump

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [sWarningSoundPool playSoundWithKey:@"[witchdrive-malfunction]" priority:1.5 position:kWitchspacePosition];
}

pollApplicationControls

- (void) pollApplicationControls

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

{
    if (!pollControls) return;
    
    NSString *exceptionContext = @"setup";
    
    // does fullscreen / quit / snapshot
    MyOpenGLView  *gameView = [UNIVERSE gameView];
    GameController *gameController = [UNIVERSE gameController];
    
    BOOL onTextEntryScreen = (gui_screen == GUI_SCREEN_LONG_RANGE_CHART) || (gui_screen == GUI_SCREEN_MISSION) || 
        (gui_screen == GUI_SCREEN_SAVE) || (gui_screen == GUI_SCREEN_OXZMANAGER || (gui_screen == GUI_SCREEN_KEYBOARD_ENTRY));
 
    @try
    {
    //  command-key controls
    #if !OOLITE_MAC_OS_X || !OOLITE_64_BIT  // On 64-bit Macs, these are handled by normal menu shortcuts.
        if ([gameController inFullScreenMode])
        {
            exceptionContext = @"command key controls";
            if ([gameView isCommandFDown])
            {
                [gameView clearCommandF];
                [gameController exitFullScreenMode];
                if (mouse_control_on)
                {
                    [UNIVERSE addMessage:DESC(@"mouse-off") forCount:3.0];
                    mouse_control_on = NO;
                }
            }
            
            if ([gameView isCommandQDown])
            {
                [gameController pauseFullScreenModeToPerform:@selector(exitAppCommandQ) onTarget:gameController];
            }
        }
    #endif
        
        // handle pressing Q or [esc] in error-handling mode
        if ([self status] == STATUS_HANDLING_ERROR)
        {
            exceptionContext = @"error handling mode";
            if ([gameView isDown:113]||[gameView isDown:81]||[gameView isDown:27])   // 'q' | 'Q' | esc
            {
                [gameController exitAppWithContext:@"Q or escape pressed in error handling mode"];
            }
        }
        
        if ([gameController isGamePaused])
        {
            // What's the status?
            switch ([self status])
            {
                case STATUS_WITCHSPACE_COUNTDOWN:
                case STATUS_IN_FLIGHT:
                case STATUS_AUTOPILOT_ENGAGED:
                case STATUS_DOCKED:
                    // Pause is handled inside their pollControls, no need to unpause.
                    break;
                    
                default:
                    {
                        // In all other cases we can't handle pause. Unpause immediately.
                        script_time = saved_script_time;
                        [gameView allowStringInput:NO];
                        if ([UNIVERSE pauseMessageVisible])
                        {
                            [UNIVERSE clearPreviousMessage];    // remove the 'paused' message.
                        }
                        [gameController setGamePaused:NO];
                    }
                    break;
            }
            
        }
        
        // snapshot
        const BOOL *joyButtonState = [[OOJoystickManager sharedStickHandler] getAllButtonStates];
 
        if (([self checkKeyPress:n_key_snapshot] || joyButtonState[BUTTON_SNAPSHOT]) &&
            ([gameView allowingStringInput] <= gvStringInputAlpha) && // not while entering text on the keyboard config screens
            ![[OOOXZManager sharedManager] isAcceptingTextInput])   //  '*' key but not while filtering inside OXZ Manager
        {
            exceptionContext = @"snapshot";
            if (!taking_snapshot)
            {
                taking_snapshot = YES;
                [gameView snapShot:nil]; // nil filename so that the program auto-names the snapshot
            }
        }
        else
        {
            taking_snapshot = NO;
        }
        
        // FPS display
        if (!onTextEntryScreen && [self checkKeyPress:n_key_show_fps])   //  'F' key
        {
            exceptionContext = @"toggle FPS";
            if (!f_key_pressed)  [UNIVERSE setDisplayFPS:![UNIVERSE displayFPS]];
            f_key_pressed = YES;
        }
        else
        {
            f_key_pressed = NO;
        }
        
        // bloom toggle
        if ([self checkKeyPress:n_key_bloom_toggle])
        {
            if (!f9_key_pressed)
            {
                BOOL oldBloom = [UNIVERSE bloom];
                [UNIVERSE setBloom:!oldBloom];
            }
            f9_key_pressed = YES;
        }
        else
        {
            f9_key_pressed = NO;
        }
        
        // Mouse control
        BOOL allowMouseControl;
    #if OO_DEBUG
        allowMouseControl = YES;
    #else
        allowMouseControl = [gameController inFullScreenMode] ||
                    [[NSUserDefaults standardUserDefaults] boolForKey:@"mouse-control-in-windowed-mode"];
    #endif
        
        if (allowMouseControl)
        {
            exceptionContext = @"mouse control";
            if (!onTextEntryScreen && ([self checkKeyPress:n_key_mouse_control_roll] || [self checkKeyPress:n_key_mouse_control_yaw]))   //  'M' key
            {
                if (!m_key_pressed)
                {
                    mouse_control_on = !mouse_control_on;
                    if (mouse_control_on)
                    {
                        [UNIVERSE addMessage:DESC(@"mouse-on") forCount:3.0];
                        /*  Ensure the keyboard pitch override (intended to lock
                         out the joystick if the player runs to the keyboard)
                         is reset */
                    #if OOLITE_GNUSTEP
                        [gameView resetMouse];
                        if ([[NSUserDefaults standardUserDefaults] boolForKey:@"grab-mouse-on-mouse-control"])
                        {
                            [gameView grabMouseInsideGameWindow:YES];
                        }
                    #endif
                        mouse_x_axis_map_to_yaw = [self checkKeyPress:n_key_mouse_control_yaw];
                        keyboardRollOverride = mouse_x_axis_map_to_yaw;   // Getafix: set keyboardRollOverride to TRUE only if yaw is mapped to mouse x-axis
                        keyboardPitchOverride = NO;
                        keyboardYawOverride = !keyboardRollOverride;
                    }
                    else
                    {
                        [UNIVERSE addMessage:DESC(@"mouse-off") forCount:3.0];
                    #if OOLITE_GNUSTEP
                        [gameView grabMouseInsideGameWindow:NO];
                    #endif
                    }
                }
                if (OOMouseInteractionModeIsFlightMode([gameController mouseInteractionMode]))
                {
                    [gameController setMouseInteractionModeForFlight];
                }
                m_key_pressed = YES;
            }
            else
            {
                m_key_pressed = NO;
            }
        }
        else
        {
            if (mouse_control_on)
            {
                mouse_control_on = NO;
                [UNIVERSE addMessage:DESC(@"mouse-off") forCount:3.0];
            #if OOLITE_GNUSTEP
                [gameView grabMouseInsideGameWindow:NO];
            #endif
                
                if (OOMouseInteractionModeIsFlightMode([gameController mouseInteractionMode]))
                {
                    [gameController setMouseInteractionModeForFlight];
                }
            }
        }
        
        // HUD toggle
        if (([self checkKeyPress:n_key_hud_toggle] || joyButtonState[BUTTON_TOGGLEHUD]) && [gameController isGamePaused] && !onTextEntryScreen) // 'o' key while paused
        {
            exceptionContext = @"toggle HUD";
            if (!hide_hud_pressed)
            {
                HeadUpDisplay *theHUD = [self hud];
                [theHUD setHidden:![theHUD isHidden]];
                if (gui_screen == GUI_SCREEN_STATUS)
                {
                    // ensure refresh of status page screen if looking at it
                    [self setGuiToStatusScreen];
                }
            }
            hide_hud_pressed = YES;
        }
        else
        {
            hide_hud_pressed = NO;
        }
    }
    @catch (NSException *exception)
    {
        OOLog(kOOLogException, @"***** Exception in pollApplicationControls [%@]: %@ : %@", exceptionContext, [exception name], [exception reason]);
    }
}

pollAutopilotControls:

- (void) pollAutopilotControls: (double)  delta_t

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

                              :(double)delta_t
{
    // don't do anything if we're configuring the keyboard
    if (gui_screen == GUI_SCREEN_KEYBOARD_ENTRY || gui_screen == GUI_SCREEN_KEYBOARD_CONFIG || gui_screen == GUI_SCREEN_KEYBOARD_LAYOUT || gui_screen == GUI_SCREEN_KEYBOARD || gui_screen == GUI_SCREEN_KEYBOARD_CONFIRMCLEAR) return;
 
    const BOOL *joyButtonState = [[OOJoystickManager sharedStickHandler] getAllButtonStates];
 
    // controls polled while the autopilot is active
    if (![[UNIVERSE gameController] isGamePaused])
    {
        //  view keys
        [self pollViewControls];
        
        //  text displays
        [self pollGuiScreenControls];
        
        if ([UNIVERSE displayGUI])
            [self pollGuiArrowKeyControls:delta_t];
        
        if ([self checkKeyPress:n_key_autopilot] || joyButtonState[BUTTON_DOCKCPU]
            || [self checkKeyPress:n_key_autodock] || joyButtonState[BUTTON_DOCKCPUFAST])   // look for the 'c' and 'C' key
        {
            if ([self hasDockingComputer] && !autopilot_key_pressed && !fast_autopilot_key_pressed)
            {
                [self disengageAutopilot];
                [UNIVERSE addMessage:DESC(@"autopilot-off") forCount:4.5];
            }
            autopilot_key_pressed = YES;
            if ([self checkKeyPress:n_key_autodock] || joyButtonState[BUTTON_DOCKCPUFAST])
            {
                fast_autopilot_key_pressed = YES;
            }
        }
        else
        {
            autopilot_key_pressed = NO;
            fast_autopilot_key_pressed = NO;
        }
        
        if (([self checkKeyPress:n_key_docking_music] || joyButtonState[BUTTON_DOCKINGMUSIC]))   // look for the 's' key
        {
            if (!toggling_music)
            {
                [[OOMusicController sharedController] toggleDockingMusic];
            }
            toggling_music = YES;
        }
        else
        {
            toggling_music = NO;
        }
        // look for the pause game, 'p' key
        if (([self checkKeyPress:n_key_pausebutton] || joyButtonState[BUTTON_PAUSE]) && gui_screen != GUI_SCREEN_SHORT_RANGE_CHART && gui_screen != GUI_SCREEN_MISSION && gui_screen != GUI_SCREEN_KEYBOARD_ENTRY)
        {
            if (!autopilot_pause)
            {
                playing_music = [[OOMusicController sharedController] isPlaying];
                if (playing_music)  [[OOMusicController sharedController] toggleDockingMusic];
                // normal flight controls can handle the rest.
                pause_pressed = NO; // pause button flag must be NO for pollflightControls to react!
                [self pollFlightControls:delta_t];
            }
            autopilot_pause = YES;
        }
        else
        {
            autopilot_pause = NO;
        }
    }
    else
    {
        // paused
        if ([self checkKeyPress:n_key_pausebutton] || joyButtonState[BUTTON_PAUSE])
        {
            if (!autopilot_pause)
            {
                if (playing_music)  [[OOMusicController sharedController] toggleDockingMusic];
            }
            autopilot_pause = YES;
        }
        else
        {
            autopilot_pause = NO;
        }
        // let the normal flight controls handle paused commands.
        [self pollFlightControls:delta_t];
    }
}

pollControls:

- (void) pollControls:

(double)

delta_t

Provided by category PlayerEntity(Controls).

Definition at line 164 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]);
    }
}

pollCustomViewControls

- (void) pollCustomViewControls

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

{
    static Quaternion viewQuaternion;
    static Vector viewOffset;
    static Vector rotationCenter;
    static Vector up;
    static Vector right;
    static BOOL mouse_clicked = NO;
    static NSPoint mouse_clicked_position;
    static BOOL shift_down;
    static BOOL caps_on = NO;
    static NSTimeInterval last_time = 0.0;
    MyOpenGLView *gameView = [UNIVERSE gameView];
    const BOOL *joyButtonState = [[OOJoystickManager sharedStickHandler] getAllButtonStates];
 
    if ([self checkKeyPress:n_key_custom_view] || joyButtonState[BUTTON_EXTVIEWCYCLE])
    {
        if (!customView_pressed && [_customViews count] != 0 && gui_screen != GUI_SCREEN_LONG_RANGE_CHART && ![gameView allowingStringInput])
        {
            if ([UNIVERSE viewDirection] == VIEW_CUSTOM)    // already in custom view mode
            {
                // rotate the custom views
                _customViewIndex = (_customViewIndex + 1) % [_customViews count];
            }
    
            [self setCustomViewDataFromDictionary:[_customViews oo_dictionaryAtIndex:_customViewIndex] withScaling:YES];
    
            [self switchToThisView:VIEW_CUSTOM andProcessWeaponFacing:NO]; // weapon facing must not change, we just want an external view
        }
        customView_pressed = YES;
    }
    else
        customView_pressed = NO;
    NSTimeInterval this_time = [NSDate timeIntervalSinceReferenceDate];
    if ([UNIVERSE viewDirection] > VIEW_STARBOARD && [gameView isCapsLockOn])
    {
        BOOL ctrl_down = [gameView isCtrlDown];
        float customViewZoomSpeed = ctrl_down ? CUSTOM_VIEW_ZOOM_SPEED * CUSTOM_VIEW_SPEED_REDUCTION_FACTOR: CUSTOM_VIEW_ZOOM_SPEED;
        float customViewRotateSpeed = ctrl_down ? CUSTOM_VIEW_ROTATE_SPEED * CUSTOM_VIEW_SPEED_REDUCTION_FACTOR: CUSTOM_VIEW_ROTATE_SPEED;
        
        if (!caps_on)  caps_on = YES;
        
        OOTimeDelta delta_t = this_time - last_time;
        if (([self checkKeyPress:n_key_custom_view_zoom_out ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_zoom_in ignore_ctrl:YES]) || [gameView mouseWheelState] == gvMouseWheelDown)
        {
            [self customViewZoomOut: pow(customViewZoomSpeed, delta_t)];
        }
        if (([self checkKeyPress:n_key_custom_view_zoom_in ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_zoom_out ignore_ctrl:YES]) || [gameView mouseWheelState] == gvMouseWheelUp)
        {
            [self customViewZoomIn: pow(customViewZoomSpeed, delta_t)];
        }
        if ([self checkKeyPress:n_key_custom_view_roll_left ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_roll_right ignore_ctrl:YES])
        {
            [self customViewRollLeft:customViewRotateSpeed * delta_t];
        }
        if ([self checkKeyPress:n_key_custom_view_pan_left ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_pan_right ignore_ctrl:YES])
        {
            [self customViewPanLeft:customViewRotateSpeed * delta_t];
        }
        if ([self checkKeyPress:n_key_custom_view_roll_right ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_roll_left ignore_ctrl:YES])
        {
            [self customViewRollRight:customViewRotateSpeed * delta_t];
        }
        if ([self checkKeyPress:n_key_custom_view_pan_right ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_pan_left ignore_ctrl:YES])
        {
            [self customViewPanRight:customViewRotateSpeed * delta_t];
        }
        if ([self checkKeyPress:n_key_custom_view_rotate_up ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_rotate_down ignore_ctrl:YES])
        {
            [self customViewRotateUp:customViewRotateSpeed * delta_t];
        }
        if ([self checkKeyPress:n_key_custom_view_pan_down ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_pan_up ignore_ctrl:YES])
        {
            [self customViewPanDown:customViewRotateSpeed * delta_t];
        }
        if ([self checkKeyPress:n_key_custom_view_rotate_down ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_rotate_up ignore_ctrl:YES])
        {
            [self customViewRotateDown:customViewRotateSpeed * delta_t];
        }
        if ([self checkKeyPress:n_key_custom_view_pan_up ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_pan_down ignore_ctrl:YES])
        {
            [self customViewPanUp:customViewRotateSpeed * delta_t];
        }
        if ([self checkKeyPress:n_key_custom_view_rotate_left ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_rotate_right ignore_ctrl:YES])
        {
            [self customViewRotateLeft:customViewRotateSpeed * delta_t];
        }
        if ([self checkKeyPress:n_key_custom_view_rotate_right ignore_ctrl:YES] && ![self checkKeyPress:n_key_custom_view_rotate_left ignore_ctrl:YES])
        {
            [self customViewRotateRight:customViewRotateSpeed * delta_t];
        }
        if ([gameView isDown:gvMouseLeftButton])
        {
            if(!mouse_clicked || shift_down != [gameView isShiftDown])
            {
                mouse_clicked = YES;
                viewQuaternion = [PLAYER customViewQuaternion];
                viewOffset = [PLAYER customViewOffset];
                rotationCenter = [PLAYER customViewRotationCenter];
                up = [PLAYER customViewUpVector];
                right = [PLAYER customViewRightVector];
                mouse_clicked_position = [gameView virtualJoystickPosition];
                shift_down = [gameView isShiftDown];
            }
            NSPoint mouse_position = [gameView virtualJoystickPosition];
            Vector axis = vector_add(vector_multiply_scalar(up, mouse_position.x - mouse_clicked_position.x),
                vector_multiply_scalar(right, mouse_position.y - mouse_clicked_position.y));
            float angle = magnitude(axis);
            axis = vector_normal(axis);
            Quaternion newViewQuaternion = viewQuaternion;
            if ([gameView isShiftDown])
            {
                quaternion_rotate_about_axis(&newViewQuaternion, axis, angle);
                [PLAYER setCustomViewQuaternion: newViewQuaternion];
                [PLAYER setCustomViewRotationCenter: vector_subtract(viewOffset,
                    vector_multiply_scalar([PLAYER customViewForwardVector],
                        dot_product([PLAYER customViewForwardVector], viewOffset)))];
            }
            else
            {
                quaternion_rotate_about_axis(&newViewQuaternion, axis, -angle);
                OOScalar m = magnitude(vector_subtract(viewOffset, rotationCenter));
                [PLAYER setCustomViewQuaternion: newViewQuaternion];
                Vector offset = vector_flip([PLAYER customViewForwardVector]);
                scale_vector(&offset, m / magnitude(offset));
                [PLAYER setCustomViewOffset:vector_add(offset, rotationCenter)];
            }
        }
        else
        {
            mouse_clicked = NO;
        }
    }
    else
    {
        mouse_clicked = NO;
        if (caps_on)
        {
            caps_on = NO;
            if ([self isMouseControlOn])  [gameView resetMouse];
        }
    }
    last_time = this_time;
}

pollDemoControls:

- (void) pollDemoControls: (double)  delta_t

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

                         :(double)delta_t
{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
    NSUInteger end_row = 21;
    OOOXZManager *oxzmanager = [OOOXZManager sharedManager];
 
    switch (gui_screen)
    {
        case GUI_SCREEN_INTRO1:
            [self handleGUIUpDownArrowKeys];
 
            int row_zero = 21;
            if (!selectPressed)
            {
                if (!disc_operation_in_progress)
                {
                    if (([gameView isDown:gvMouseDoubleClick] || [self checkKeyPress:n_key_gui_select]) && [gui selectedRow] == 2+row_zero)
                    {
                        disc_operation_in_progress = YES;
                        [UNIVERSE removeDemoShips];
                        [gui clearBackground];
                        if (![self loadPlayer])
                        {
                            [self setGuiToIntroFirstGo:YES];
                        }
                        break;
                    }
                }
                if (([gameView isDown:gvMouseDoubleClick] || [self checkKeyPress:n_key_gui_select]) && [gui selectedRow] == 1+row_zero)
                {
                    missionTextRow = 0;
                    [self setGuiToScenarioScreen:0];
                } 
                else if (([gameView isDown:gvMouseDoubleClick] || [self checkKeyPress:n_key_gui_select]) && [gui selectedRow] == 3+row_zero)
                {
                    [self setGuiToIntroFirstGo:NO];
                }
                else if (([gameView isDown:gvMouseDoubleClick] || [self checkKeyPress:n_key_gui_select]) && [gui selectedRow] == 4+row_zero)
                {
                    [self setGuiToGameOptionsScreen];
                }
                else if (([gameView isDown:gvMouseDoubleClick] || [self checkKeyPress:n_key_gui_select]) && [gui selectedRow] == 5+row_zero)
                {
                    [self setGuiToOXZManager];
                }
                else if (([gameView isDown:gvMouseDoubleClick] || [self checkKeyPress:n_key_gui_select]) && [gui selectedRow] == 6+row_zero)
                {
                    [[UNIVERSE gameController] exitAppWithContext:@"Exit Game selected on start screen"];
                }
                else
                {
                    disc_operation_in_progress = NO;
                }
            }
            selectPressed = [self checkKeyPress:n_key_gui_select];
            if ([gameView isDown:gvMouseDoubleClick])
            {
                [gameView clearMouse];
            }
            break;
            
        case GUI_SCREEN_GAMEOPTIONS:
            [self handleGameOptionsScreenKeys];
            break;
            
        case GUI_SCREEN_KEYBOARD:
            //if ([gameView isDown:' '])    //  '<space>'
            //{
            //  [self setGuiToIntroFirstGo:YES];
            //}
            [self handleKeyMapperScreenKeys];
            break;
 
        case GUI_SCREEN_KEYBOARD_CONFIRMCLEAR:
            [self handleKeyMapperConfirmClearKeys:gui view:gameView];
            break;
 
        case GUI_SCREEN_KEYBOARD_CONFIG:
            [self handleKeyConfigKeys:gui view:gameView];
            break;
 
        case GUI_SCREEN_KEYBOARD_ENTRY:
            [self handleKeyConfigEntryKeys:gui view:gameView];
            break;
 
        case GUI_SCREEN_KEYBOARD_LAYOUT:
            [self handleKeyboardLayoutKeys];
            break;
 
        case GUI_SCREEN_STICKMAPPER:
            [self handleStickMapperScreenKeys];
            break;
            
        case GUI_SCREEN_STICKPROFILE:
            [self stickProfileInputHandler:gui view:gameView];
            break;
 
        case GUI_SCREEN_SHIPLIBRARY:
            if ([gameView isDown:' '])  //  '<space>'
            {
                // viewed from start screen, return to it
                [self setGuiToIntroFirstGo:YES];
            }
            if ([self checkKeyPress:n_key_gui_arrow_up])    //  '<--'
            {
                if (!upDownKeyPressed)
                    [UNIVERSE selectIntro2Previous];
            }
            if ([self checkKeyPress:n_key_gui_arrow_down])  //  '-->'
            {
                if (!upDownKeyPressed)
                    [UNIVERSE selectIntro2Next];
            }
            upDownKeyPressed = (([self checkKeyPress:n_key_gui_arrow_up])||([self checkKeyPress:n_key_gui_arrow_down]));
 
            if ([self checkKeyPress:n_key_gui_arrow_left])  //  '<--'
            {
                if (!leftRightKeyPressed)
                    [UNIVERSE selectIntro2PreviousCategory];
            }
            if ([self checkKeyPress:n_key_gui_arrow_right]) //  '-->'
            {
                if (!leftRightKeyPressed)
                    [UNIVERSE selectIntro2NextCategory];
            }
            leftRightKeyPressed = (([self checkKeyPress:n_key_gui_arrow_left])||([self checkKeyPress:n_key_gui_arrow_right]));
            
 
            break;
        
        case GUI_SCREEN_NEWGAME:
            if ([self handleGUIUpDownArrowKeys])
            {
                [self showScenarioDetails];
            }
 
            if (!pageUpDownKeyPressed) 
            {
                if ([self checkKeyPress:n_key_gui_page_up])
                {
                    //  find the Back <<< line, select it and press it
                    if ([[gui keyForRow:GUI_ROW_SCENARIOS_START - 1] hasPrefix:@"__page"]) 
                    {
                        if ([gui setSelectedRow:GUI_ROW_SCENARIOS_START - 1]) 
                        {
                            [self startScenario];
                        }
                    }
 
                }
                else if ([self checkKeyPress:n_key_gui_page_down])
                {
                    // find the Next >>> line, select it and press it
                    if ([[gui keyForRow:GUI_ROW_SCENARIOS_START + GUI_MAX_ROWS_SCENARIOS] hasPrefix:@"__page"]) 
                    {
                        if ([gui setSelectedRow:GUI_ROW_SCENARIOS_START + GUI_MAX_ROWS_SCENARIOS]) 
                        {
                            [self startScenario];
                        }
                    }
                }
            }
            pageUpDownKeyPressed = [self checkKeyPress:n_key_gui_page_down]|[self checkKeyPress:n_key_gui_page_up];
 
            if (!selectPressed)
            {
                if ([self checkKeyPress:n_key_gui_select] || [gameView isDown:gvMouseDoubleClick]) // enter
                {
                    if (![self startScenario])
                    {
                        [UNIVERSE removeDemoShips];
                        [self setGuiToIntroFirstGo:YES];
                    } 
                }
            }
            selectPressed = [self checkKeyPress:n_key_gui_select];
            if ([gameView isDown:gvMouseDoubleClick] || [gameView isDown:gvMouseLeftButton])
            {
                [gameView clearMouse];
            }
            break;
 
        case GUI_SCREEN_OXZMANAGER:
            // release locks on music on this screen
            [[OOMusicController sharedController] stopThemeMusic];
            if (EXPECT(![oxzmanager isRestarting]))
            {
                if ([oxzmanager isAcceptingGUIInput])
                {
                    if ([oxzmanager isAcceptingTextInput])
                    {
                        [gameView setStringInput: gvStringInputAll];
                        [oxzmanager refreshTextInput:[gameView typedString]];
                    }
                    else
                    {
                        [gameView allowStringInput: NO];
                    }
                    if ([self handleGUIUpDownArrowKeys])
                    {
                        // only has an effect on install/remove selection screens
                        [oxzmanager showOptionsUpdate];
                    }
                    if ([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up])
                    {
                        if ((!leftRightKeyPressed))
                        {
                            [oxzmanager processOptionsPrev];
                        }
                    }
                    else if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down])
                    {
                        if ((!leftRightKeyPressed))
                        {
                            [oxzmanager processOptionsNext];
                        }
                    }
                    leftRightKeyPressed = [self checkKeyPress:n_key_gui_arrow_right]|[self checkKeyPress:n_key_gui_arrow_left]|[self checkKeyPress:n_key_gui_page_down]|[self checkKeyPress:n_key_gui_page_up];
 
                    if (!selectPressed)
                    {
                        if ([self checkKeyPress:n_key_gui_select] || [gameView isDown:gvMouseDoubleClick]) // enter
                        {
                            if ([oxzmanager isAcceptingTextInput])
                            {
                                [oxzmanager processTextInput:[gameView typedString]];
                            }
                            else
                            {
                                [oxzmanager processSelection];
                            }
                        }
                    }
                    selectPressed = [self checkKeyPress:n_key_gui_select];
                    if ([gameView isDown:gvMouseDoubleClick] || [gameView isDown:gvMouseLeftButton])
                    {
                        [gameView clearMouse];
                    }
                } // endif isAcceptingGUIInput
                if ([self checkKeyPress:n_key_oxzmanager_setfilter] ||
                    [self checkKeyPress:n_key_oxzmanager_showinfo] ||
                    [self checkKeyPress:n_key_oxzmanager_extract])
                {
                    if (!oxz_manager_pressed)
                    {
                        oxz_manager_pressed = YES;
                        if ([self checkKeyPress:n_key_oxzmanager_setfilter])
                        {
                            [oxzmanager processFilterKey];
                        }
                        else if ([self checkKeyPress:n_key_oxzmanager_showinfo])
                        {
                            [oxzmanager processShowInfoKey];
                        }
                        else if ([self checkKeyPress:n_key_oxzmanager_extract])
                        {
                            [oxzmanager processExtractKey];
                        }
                        
                    }
                }
                else
                {
                    oxz_manager_pressed = NO;
                }
            }
            break;
    
 
    
        case GUI_SCREEN_MISSION:
            if ([[self hud] allowBigGui])
            {
                end_row = 27;
            }
            if (_missionTextEntry)
            {
                [self refreshMissionScreenTextEntry];
                if ([self checkKeyPress:n_key_gui_select] || [gameView isDown:gvMouseDoubleClick])  //  '<enter/return>' or double click
                {
                    [self setMissionChoice:[gameView typedString] keyPress:@"enter"];
                    [[OOMusicController sharedController] stopMissionMusic];
                    [self playDismissedMissionScreen];
                    
                    [self handleMissionCallback];
                    
                    [self checkScript];
                    selectPressed = YES;
                    pollControls = YES;
                }
                else
                {
                    pollControls = NO;
                    selectPressed = NO;
                    [self pollMissionInterruptControls];
                }
            }
            else if ([[gui keyForRow:end_row] isEqual:@"spacebar"])
            {
                if ([gameView isDown:32])   //  '<space>'
                {
                    if (!spacePressed)
                    {
                        [[OOMusicController sharedController] stopMissionMusic];
                        [self handleMissionCallback];
                        
                    }
                    spacePressed = YES;
                }
                else
                {
                    spacePressed = NO;
                    [self pollMissionInterruptControls];
                }
            }
            else
            {
                [self handleGUIUpDownArrowKeys];
                NSString *extraKey = @"";
                if (extraMissionKeys)
                {
                    NSString *key = nil;
                    foreach (key, [extraMissionKeys allKeys])
                    {
                        if ([self checkKeyPress:[extraMissionKeys oo_arrayForKey:key]]) {
                            if (!extra_key_pressed)
                            {
                                extraKey = [key copy];
                            }
                            extra_key_pressed = YES;
                        }
                        else
                        extra_key_pressed = NO;
                    }
                }
                if ([self checkKeyPress:n_key_gui_select] || [gameView isDown:gvMouseDoubleClick] || [extraKey length] > 0) //  '<enter/return>' or double click
                {
                    if ([gameView isDown:gvMouseDoubleClick])
                    {
                        selectPressed = NO;
                        [gameView clearMouse];
                    }
                    if (!selectPressed)
                    {
                        if ([extraKey length] == 0) extraKey = @"enter";
                        [self setMissionChoice:[gui selectedRowKey] keyPress:extraKey];
                        [[OOMusicController sharedController] stopMissionMusic];
                        [self playDismissedMissionScreen];
                        
                        [self handleMissionCallback];
                        
                        [self checkScript];
                    }
                    selectPressed = YES;
                }
                else
                {
                    selectPressed = NO;
                    [self pollMissionInterruptControls];
                }
                [extraKey release];
            }
            break;
            
#if OO_USE_CUSTOM_LOAD_SAVE
            // DJS: Farm off load/save screen options to LoadSave.m
        case GUI_SCREEN_LOAD:
        {
            NSString *commanderFile = [self commanderSelector];
            if(commanderFile)
            {
                // also release the demo ship here (see showShipyardModel and noteGUIDidChangeFrom)
                [demoShip release];
                demoShip = nil;
                
                [self loadPlayerFromFile:commanderFile asNew:NO];
            }
            break;
        }
#endif
 
        default:
            break;
    }
}

pollDockedControls:

- (void) pollDockedControls: (double)  delta_t

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

                           :(double)delta_t
{
    MyOpenGLView            *gameView = [UNIVERSE gameView];
    GameController          *gameController = [UNIVERSE gameController];
    const BOOL *joyButtonState = [[OOJoystickManager sharedStickHandler] getAllButtonStates];
    NSString                *exceptionContext = @"setup";
    
    @try
    {
        // Pause game, 'p' key
        exceptionContext = @"pause key";
        if (([self checkKeyPress:n_key_pausebutton] || joyButtonState[BUTTON_PAUSE]) && (gui_screen != GUI_SCREEN_LONG_RANGE_CHART &&
                gui_screen != GUI_SCREEN_REPORT &&
                gui_screen != GUI_SCREEN_SAVE && gui_screen != GUI_SCREEN_KEYBOARD_ENTRY) )
        {
            BOOL isMissionScreenWithTextEntry = gui_screen == GUI_SCREEN_MISSION && _missionTextEntry;
            if (!pause_pressed)
            {
                if ([gameController isGamePaused])
                {
                    script_time = saved_script_time;
                    [gameView allowStringInput:NO];
                    if ([UNIVERSE pauseMessageVisible])
                    {
                        [UNIVERSE clearPreviousMessage];    // remove the 'paused' message.
                    }
                    [[UNIVERSE gui] setForegroundTextureKey:@"docked_overlay"];
                    [gameController setGamePaused:NO];
                }
                else
                {
                    if (!isMissionScreenWithTextEntry)
                    {
                        saved_script_time = script_time;
                        [[UNIVERSE messageGUI] clear];
                        
                        [UNIVERSE pauseGame];   // 'paused' handler
                    }
                }
            }
            if (!isMissionScreenWithTextEntry)
            {
                pause_pressed = YES;
            }
        }
        else
        {
            pause_pressed = NO;
        }
        
        if ([gameController isGamePaused]) return;
        
        if(pollControls)
        {
            exceptionContext = @"undock";
            if ([self checkKeyPress:n_key_launch_ship])
            {
                if (EXPECT((gui_screen != GUI_SCREEN_MISSION || _missionAllowInterrupt) && gui_screen != GUI_SCREEN_KEYBOARD_ENTRY))
                {
                    [self handleUndockControl];
                }
            }
        }
        
        //  text displays
        // mission screens
        exceptionContext = @"GUI keys";
        if (gui_screen == GUI_SCREEN_MISSION || gui_screen == GUI_SCREEN_KEYBOARD_ENTRY)
        {
            [self pollDemoControls: delta_t];   // don't switch away from mission screens
        }
        else
        {
            if (gui_screen != GUI_SCREEN_REPORT)[self pollGuiScreenControls];   // don't switch away from report screens
        }
        
        [self pollGuiArrowKeyControls:delta_t];
    }
    @catch (NSException *exception)
    {
        OOLog(kOOLogException, @"***** Exception in pollDockedControls [%@]: %@ : %@", exceptionContext, [exception name], [exception reason]);
    }
}

pollFlightArrowKeyControls:

- (void) pollFlightArrowKeyControls: (double)  delta_t

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

                                   :(double)delta_t
{
    MyOpenGLView        *gameView = [UNIVERSE gameView];
    OOJoystickManager   *stickHandler = [OOJoystickManager sharedStickHandler];
    NSUInteger          numSticks = [stickHandler joystickCount];
    NSPoint             virtualStick = NSZeroPoint;
    double              reqYaw = 0.0;
    
    /*  DJS: Handle inputs on the joy roll/pitch axis.
     Mouse control on takes precedence over joysticks.
     We have to assume the player has a reason for switching mouse
     control on if they have a joystick - let them do it. */
    if (mouse_control_on)
    {
        virtualStick=[gameView virtualJoystickPosition];
        double sensitivity = 2.0;
        virtualStick.x *= sensitivity;
        virtualStick.y *= sensitivity;
        reqYaw = virtualStick.x;
    }
    else if (numSticks > 0)
    {
        virtualStick = [stickHandler rollPitchAxis];
        // handle roll separately (fix for BUG #17490)
        if(virtualStick.x == STICK_AXISUNASSIGNED)
        {
            // Not assigned - set to zero.
            virtualStick.x=0;
        }
        else if(virtualStick.x != 0)
        {
            // cancel keyboard override, stick has been waggled
            keyboardRollOverride=NO;
        }
        // handle pitch separately (fix for BUG #17490)
        if(virtualStick.y == STICK_AXISUNASSIGNED)
        {
            // Not assigned - set to zero.
            virtualStick.y=0;
        }
        else if(virtualStick.y != 0)
        {
            // cancel keyboard override, stick has been waggled
            keyboardPitchOverride=NO;
        }
        // handle yaw separately from pitch/roll
        reqYaw = [stickHandler getAxisState: AXIS_YAW];
        if(reqYaw == STICK_AXISUNASSIGNED)
        {
            // Not assigned or deadzoned - set to zero.
            reqYaw=0;
        }
        else if(reqYaw != 0)
        {
            // cancel keyboard override, stick has been waggled
            keyboardYawOverride=NO;
        }
    }
    
    double roll_dampner = ROLL_DAMPING_FACTOR * delta_t;
    double pitch_dampner = PITCH_DAMPING_FACTOR * delta_t;
    double yaw_dampner = YAW_DAMPING_FACTOR * delta_t;
    BOOL capsLockCustomView = [UNIVERSE viewDirection] == VIEW_CUSTOM && [gameView isCapsLockOn];
    
    BOOL    isCtrlDown = [gameView isCtrlDown];
    
    double  flightArrowKeyPrecisionFactor = [[NSUserDefaults standardUserDefaults] oo_doubleForKey:@"flight-arrow-key-precision-factor" defaultValue:0.5];
    if (flightArrowKeyPrecisionFactor < 0.05)  flightArrowKeyPrecisionFactor = 0.05;
    if (flightArrowKeyPrecisionFactor > 1.0)  flightArrowKeyPrecisionFactor = 1.0; 
    
    rolling = NO;
    // if we have yaw on the mouse x-axis, then allow using the keyboard roll keys
    if (!mouse_control_on || (mouse_control_on && mouse_x_axis_map_to_yaw))
    {
        if ([self checkNavKeyPress:n_key_roll_left] && [self checkNavKeyPress:n_key_roll_right])
        {
            keyboardRollOverride = YES;
            flightRoll = 0.0;
        }
        else if ([self checkNavKeyPress:n_key_roll_left] && !capsLockCustomView)
        {
            keyboardRollOverride=YES;
            if (flightRoll > 0.0)  flightRoll = 0.0;
            [self decrease_flight_roll:isCtrlDown ? flightArrowKeyPrecisionFactor*roll_dampner*roll_delta : delta_t*roll_delta];
            rolling = YES;
        }
        else if ([self checkNavKeyPress:n_key_roll_right] && !capsLockCustomView)
        {
            keyboardRollOverride=YES;
            if (flightRoll < 0.0)  flightRoll = 0.0;
            [self increase_flight_roll:isCtrlDown ? flightArrowKeyPrecisionFactor*roll_dampner*roll_delta : delta_t*roll_delta];
            rolling = YES;
        }
    }
    if(((mouse_control_on && !mouse_x_axis_map_to_yaw) || numSticks) && !keyboardRollOverride && !capsLockCustomView)
    {
        stick_roll = max_flight_roll * virtualStick.x;
        if (flightRoll < stick_roll)
        {
            [self increase_flight_roll:delta_t*roll_delta];
            if (flightRoll > stick_roll)
                flightRoll = stick_roll;
        }
        if (flightRoll > stick_roll)
        {
            [self decrease_flight_roll:delta_t*roll_delta];
            if (flightRoll < stick_roll)
                flightRoll = stick_roll;
        }
        rolling = (fabs(virtualStick.x) > 0.0);
    }
    if (!rolling)
    {
        if (flightRoll > 0.0)
        {
            if (flightRoll > roll_dampner)  [self decrease_flight_roll:roll_dampner];
            else    flightRoll = 0.0;
        }
        if (flightRoll < 0.0)
        {
            if (flightRoll < -roll_dampner)   [self increase_flight_roll:roll_dampner];
            else    flightRoll = 0.0;
        }
    }
    
    pitching = NO;
    // we don't care about pitch keyboard overrides when mouse control is on, only when using joystick
    if (!mouse_control_on)
    {
        if ([self checkNavKeyPress:n_key_pitch_back] && [self checkNavKeyPress:n_key_pitch_forward])
        {
            keyboardPitchOverride=YES;
            flightPitch = 0.0;
        }
        else if ([self checkNavKeyPress:n_key_pitch_back] && !capsLockCustomView)
        {
            keyboardPitchOverride=YES;
            if (flightPitch < 0.0)  flightPitch = 0.0;
            [self increase_flight_pitch:isCtrlDown ? flightArrowKeyPrecisionFactor*pitch_dampner*pitch_delta : delta_t*pitch_delta];
            pitching = YES;
        }
        else if ([self checkNavKeyPress:n_key_pitch_forward] && !capsLockCustomView)
        {
            keyboardPitchOverride=YES;
            if (flightPitch > 0.0)  flightPitch = 0.0;
            [self decrease_flight_pitch:isCtrlDown ? flightArrowKeyPrecisionFactor*pitch_dampner*pitch_delta : delta_t*pitch_delta];
            pitching = YES;
        }
    }
    if((mouse_control_on || (numSticks && !keyboardPitchOverride)) && !capsLockCustomView)
    {
        stick_pitch = max_flight_pitch * virtualStick.y;
        if (flightPitch < stick_pitch)
        {
            [self increase_flight_pitch:delta_t*pitch_delta];
            if (flightPitch > stick_pitch)
                flightPitch = stick_pitch;
        }
        if (flightPitch > stick_pitch)
        {
            [self decrease_flight_pitch:delta_t*pitch_delta];
            if (flightPitch < stick_pitch)
                flightPitch = stick_pitch;
        }
        pitching = (fabs(virtualStick.y) > 0.0);
    }
    if (!pitching)
    {
        if (flightPitch > 0.0)
        {
            if (flightPitch > pitch_dampner)    [self decrease_flight_pitch:pitch_dampner];
            else    flightPitch = 0.0;
        }
        if (flightPitch < 0.0)
        {
            if (flightPitch < -pitch_dampner)   [self increase_flight_pitch:pitch_dampner];
            else    flightPitch = 0.0;
        }
    }
    
    yawing = NO;
    // if we have roll on the mouse x-axis, then allow using the keyboard yaw keys
    if (!mouse_control_on || (mouse_control_on && !mouse_x_axis_map_to_yaw))
    {
        if ([self checkNavKeyPress:n_key_yaw_left] && [self checkNavKeyPress:n_key_yaw_right])
        {
            keyboardYawOverride=YES;
            flightYaw = 0.0;
        }
        else if ([self checkNavKeyPress:n_key_yaw_left] && !capsLockCustomView)
        {
            keyboardYawOverride=YES;
            if (flightYaw < 0.0)  flightYaw = 0.0;
            [self increase_flight_yaw:isCtrlDown ? flightArrowKeyPrecisionFactor*yaw_dampner*yaw_delta : delta_t*yaw_delta];
            yawing = YES;
        }
        else if ([self checkNavKeyPress:n_key_yaw_right] && !capsLockCustomView)
        {
            keyboardYawOverride=YES;
            if (flightYaw > 0.0)  flightYaw = 0.0;
            [self decrease_flight_yaw:isCtrlDown ? flightArrowKeyPrecisionFactor*yaw_dampner*yaw_delta : delta_t*yaw_delta];
            yawing = YES;
        }
    }
    if(((mouse_control_on && mouse_x_axis_map_to_yaw) || numSticks) && !keyboardYawOverride && !capsLockCustomView)
    {
        // I think yaw is handled backwards in the code,
        // which is why the negative sign is here.
        stick_yaw = max_flight_yaw * (-reqYaw);
        if (flightYaw < stick_yaw)
        {
            [self increase_flight_yaw:delta_t*yaw_delta];
            if (flightYaw > stick_yaw)
                flightYaw = stick_yaw;
        }
        if (flightYaw > stick_yaw)
        {
            [self decrease_flight_yaw:delta_t*yaw_delta];
            if (flightYaw < stick_yaw)
                flightYaw = stick_yaw;
        }
        yawing = (fabs(reqYaw) > 0.0);
    }
    if (!yawing)
    {
        if (flightYaw > 0.0)
        {
            if (flightYaw > yaw_dampner)    [self decrease_flight_yaw:yaw_dampner];
            else    flightYaw = 0.0;
        }
        if (flightYaw < 0.0)
        {
            if (flightYaw < -yaw_dampner)   [self increase_flight_yaw:yaw_dampner];
            else    flightYaw = 0.0;
        }
    }
 
}

pollFlightControls:

- (void) pollFlightControls: (double)  delta_t

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

                           :(double)delta_t
{
    MyOpenGLView        *gameView = [UNIVERSE gameView];
    OOJoystickManager   *stickHandler = [OOJoystickManager sharedStickHandler];
    NSString            *exceptionContext = @"setup";
 
    @try
    {
        exceptionContext = @"joystick handling";
        const BOOL *joyButtonState = [[OOJoystickManager sharedStickHandler] getAllButtonStates];
        
        BOOL paused = [[UNIVERSE gameController] isGamePaused];
        double speed_delta = SHIP_THRUST_FACTOR * thrust;
        
        if (!paused && gui_screen == GUI_SCREEN_MISSION)
        {
            exceptionContext = @"mission screen";
            OOViewID view = VIEW_NONE;
            
            NSPoint         virtualView = NSZeroPoint;
            double          view_threshold = 0.5;
            
            if ([stickHandler joystickCount])
            {
                virtualView = [stickHandler viewAxis];
                if (virtualView.y == STICK_AXISUNASSIGNED)
                    virtualView.y = 0.0;
                if (virtualView.x == STICK_AXISUNASSIGNED)
                    virtualView.x = 0.0;
                if (fabs(virtualView.y) >= fabs(virtualView.x))
                    virtualView.x = 0.0; // forward/aft takes precedence
                else
                    virtualView.y = 0.0;
            }
        
            if ([self checkKeyPress:n_key_view_forward] || (virtualView.y < -view_threshold) || joyButtonState[BUTTON_VIEWFORWARD])
            {
                view = VIEW_FORWARD;
            }
            if ([self checkKeyPress:n_key_view_aft]|(virtualView.y > view_threshold)||joyButtonState[BUTTON_VIEWAFT])
            {
                view = VIEW_AFT;
            }
            if ([self checkKeyPress:n_key_view_port]||(virtualView.x < -view_threshold)||joyButtonState[BUTTON_VIEWPORT])
            {
                view = VIEW_PORT;
            }
            if ([self checkKeyPress:n_key_view_starboard]||(virtualView.x > view_threshold)||joyButtonState[BUTTON_VIEWSTARBOARD])
            {
                view = VIEW_STARBOARD;
            }
            if (view == VIEW_NONE)
            {
                // still in mission screen, process the input.
                [self pollDemoControls: delta_t];
            }
            else
            {
                [[UNIVERSE gui] clearBackground];
                [self switchToThisView:view];
                if (_missionWithCallback)
                {
                    [self doMissionCallback];
                }
                // notify older scripts, but do not trigger missionScreenOpportunity.
                [self doWorldEventUntilMissionScreen:OOJSID("missionScreenEnded")];
            }
        }
        else if (!paused)
        {
            exceptionContext = @"arrow keys";
            // arrow keys
            if ([UNIVERSE displayGUI])
                [self pollGuiArrowKeyControls:delta_t];
            else
                [self pollFlightArrowKeyControls:delta_t];
            
            //  view keys
            [self pollViewControls];
            
            if (OOMouseInteractionModeIsFlightMode([[UNIVERSE gameController] mouseInteractionMode]))
            {
                exceptionContext = @"afterburner";
                if ((joyButtonState[BUTTON_FUELINJECT] || [self checkKeyPress:n_key_inject_fuel]) &&
                    [self hasFuelInjection] &&
                    !hyperspeed_engaged)
                {
                    if (fuel > 0 && !afterburner_engaged)
                    {
                        [UNIVERSE addMessage:DESC(@"fuel-inject-on") forCount:1.5];
                        afterburner_engaged = YES;
                        [self startAfterburnerSound];
                    }
                    else
                    {
                        if (fuel <= 0.0)
                            [UNIVERSE addMessage:DESC(@"fuel-out") forCount:1.5];
                    }
                    afterburner_engaged = (fuel > 0);
                }
                else
                    afterburner_engaged = NO;
                
                if ((!afterburner_engaged)&&(afterburnerSoundLooping))
                    [self stopAfterburnerSound];
                
                exceptionContext = @"thrust";
                // DJS: Thrust can be an axis or a button. Axis takes precidence.
                double reqSpeed=[stickHandler getAxisState: AXIS_THRUST];
                float mouseWheelDeltaFactor = mouse_control_on ? fabs([gameView mouseWheelDelta]) : 1.0f;
                if (mouseWheelDeltaFactor == 0.0f)  mouseWheelDeltaFactor = 1.0f;
                // Updated DJS original code to fix BUG #17482 - (Getafix 2010/09/13)
                if (([self checkKeyPress:n_key_increase_speed] ||
                        joyButtonState[BUTTON_INCTHRUST] ||
                         ((mouse_control_on)&&([gameView mouseWheelState] == gvMouseWheelUp) && ([UNIVERSE viewDirection] <= VIEW_STARBOARD || ![gameView isCapsLockOn])))
                    && (flightSpeed < maxFlightSpeed) && (!afterburner_engaged))
                {
                    flightSpeed += speed_delta * delta_t * mouseWheelDeltaFactor;
                }
                
                if (([self checkKeyPress:n_key_decrease_speed] ||
                        joyButtonState[BUTTON_DECTHRUST] ||
                        ((mouse_control_on)&&([gameView mouseWheelState] == gvMouseWheelDown) && ([UNIVERSE viewDirection] <= VIEW_STARBOARD || ![gameView isCapsLockOn])))
                    && (!afterburner_engaged))
                {
                    flightSpeed -= speed_delta * delta_t * mouseWheelDeltaFactor;   
                    // ** tgape ** - decrease obviously means no hyperspeed
                    hyperspeed_engaged = NO;
                }
 
                NSDictionary *functionForThrustAxis = [[stickHandler axisFunctions] oo_dictionaryForKey:[[NSNumber numberWithInt:AXIS_THRUST] stringValue]];
                if([stickHandler joystickCount] != 0 && functionForThrustAxis != nil)
                {
                    if (flightSpeed < maxFlightSpeed * reqSpeed)
                    {
                        flightSpeed += speed_delta * delta_t;
                    }
                    if (flightSpeed > maxFlightSpeed * reqSpeed)
                    {
                        flightSpeed -= speed_delta * delta_t;
                    }
                } // DJS: end joystick thrust axis (Getafix - End code update for fixing BUG #17482)
                
                if (!afterburner_engaged && ![self atHyperspeed] && !hyperspeed_engaged)
                {
                    flightSpeed = OOClamp_0_max_f(flightSpeed, maxFlightSpeed);
                }
                
                exceptionContext = @"hyperspeed";
                //  hyperspeed controls
                if ([self checkKeyPress:n_key_jumpdrive] || joyButtonState[BUTTON_HYPERSPEED])      // 'j'
                {
                    if (!jump_pressed)
                    {
                        if (!hyperspeed_engaged)
                        {
                            hyperspeed_locked = [self massLocked];
                            hyperspeed_engaged = !hyperspeed_locked;
                            if (hyperspeed_locked)
                            {
                                [self playJumpMassLocked];
                                [UNIVERSE addMessage:DESC(@"jump-mass-locked") forCount:1.5];
                            }
                        }
                        else
                        {
                            hyperspeed_engaged = NO;
                        }
                    }
                    jump_pressed = YES;
                }
                else
                {
                    jump_pressed = NO;
                }
                
                exceptionContext = @"shoot";
                //  shoot 'a'
                if ((([self checkNavKeyPress:n_key_fire_lasers])||((mouse_control_on)&&([gameView isDown:gvMouseLeftButton]) && ([UNIVERSE viewDirection] <= VIEW_STARBOARD || ![gameView isCapsLockOn]))||joyButtonState[BUTTON_FIRE])&&(shot_time > weapon_recharge_rate))
                {
                    if ([self fireMainWeapon])
                    {
                        [self playLaserHit:([self shipHitByLaser] != nil) offset:[[self currentLaserOffset] oo_vectorAtIndex:0] weaponIdentifier:[[self currentWeapon] identifier]];
                    }
                }
                
                exceptionContext = @"weapons online toggle";
                // weapons online / offline toggle '_'
                if (([self checkKeyPress:n_key_weapons_online_toggle] || joyButtonState[BUTTON_WEAPONSONLINETOGGLE]))
                {
                    if (!weaponsOnlineToggle_pressed)
                    {
                        NSString*   weaponsOnlineToggleMsg;
                        
                        [self setWeaponsOnline:![self weaponsOnline]];
                        weaponsOnlineToggleMsg = [self weaponsOnline] ? DESC(@"weapons-systems-online") : DESC(@"weapons-systems-offline");
                        if ([self weaponsOnline])
                        {
                            [self playWeaponsOnline];
                        }
                        else
                        {
                            [self playWeaponsOffline];
                        }
                        [UNIVERSE addMessage:weaponsOnlineToggleMsg forCount:2.0];
                        [self doScriptEvent:OOJSID("weaponsSystemsToggled") withArgument:[NSNumber numberWithBool:[self weaponsOnline]]];
                        weaponsOnlineToggle_pressed = YES;
                    }
                }
                else  weaponsOnlineToggle_pressed = NO;
                
                exceptionContext = @"missile fire";
                //  shoot 'm'   // launch missile
                if ([self checkKeyPress:n_key_launch_missile] || joyButtonState[BUTTON_LAUNCHMISSILE])
                {
                    // launch here
                    if (!fire_missile_pressed)
                    {
                        [self fireMissile];
                        fire_missile_pressed = YES;
                    }
                }
                else  fire_missile_pressed = NO;
                
                exceptionContext = @"next missile";
                //  shoot 'y'   // next missile
                if ([self checkKeyPress:n_key_next_missile] || joyButtonState[BUTTON_CYCLEMISSILE])
                {
                    if (!ident_engaged && !next_missile_pressed && [self weaponsOnline])
                    {
                        [self playNextMissileSelected];
                        [self selectNextMissile];
                    }
                    next_missile_pressed = YES;
                }
                else  next_missile_pressed = NO;
                
                exceptionContext = @"next target";
                //  '+' // next target
                if ([self checkKeyPress:n_key_next_target] || joyButtonState[BUTTON_NEXTTARGET])
                {
                    if ((!next_target_pressed)&&([self hasEquipmentItemProviding:@"EQ_TARGET_MEMORY"]))
                    {
                        [self moveTargetMemoryBy:+1];
                    }
                    next_target_pressed = YES;
                }
                else  next_target_pressed = NO;
                
                exceptionContext = @"previous target";
                //  '-' // previous target
                if ([self checkKeyPress:n_key_previous_target] || joyButtonState[BUTTON_PREVTARGET])
                {
                    if ((!previous_target_pressed)&&([self hasEquipmentItemProviding:@"EQ_TARGET_MEMORY"]))
                    {
                        [self moveTargetMemoryBy:-1];
                    }
                    previous_target_pressed = YES;
                }
                else  previous_target_pressed = NO;
                
                exceptionContext = @"ident R";
                //  shoot 'r'   // switch on ident system
                if ([self checkKeyPress:n_key_ident_system] || joyButtonState[BUTTON_ID])
                {
                    // ident 'on' here
                    if (!ident_pressed)
                    {
                        [self handleButtonIdent];
                    }
                    ident_pressed = YES;
                }
                else  ident_pressed = NO;
                
                exceptionContext = @"prime equipment";
                // prime equipment 'N' - selects equipment to use with keypress
                if ([self checkKeyPress:n_key_prime_next_equipment] || [self checkKeyPress:n_key_prime_previous_equipment] || joyButtonState[BUTTON_PRIMEEQUIPMENT] || joyButtonState[BUTTON_PRIMEEQUIPMENT_PREV])
                {
 
                    if (!prime_equipment_pressed)
                    {
 
                        // cycle through all the relevant equipment.
                        NSUInteger c = [eqScripts count];
                        
                        // if Ctrl is held down at the same time as the prime equipment key,
                        // cycle relevant equipment in reverse
                        //if (![gameView isCtrlDown])
                        if (![self checkKeyPress:n_key_prime_previous_equipment] || joyButtonState[BUTTON_PRIMEEQUIPMENT_PREV])
                        {
                            primedEquipment++;
                            if (primedEquipment > c) primedEquipment = 0;
                        }
                        else
                        {
                            if (primedEquipment > 0)  primedEquipment--;
                            else  primedEquipment = c;
                        }
                        
                        NSString *eqKey = @"";
 
                        if (primedEquipment == c)
                        {
                            if (c > 0)
                            {
                                [self playNextEquipmentSelected];
                                [UNIVERSE addMessage:DESC(@"equipment-primed-none") forCount:2.0];
                            }
                            else [UNIVERSE addMessage:DESC(@"equipment-primed-none-available") forCount:2.0];
                        }
                        else
                        {
                            [self playNextEquipmentSelected];
                            NSString *equipmentName = [[OOEquipmentType equipmentTypeWithIdentifier:[[eqScripts oo_arrayAtIndex:primedEquipment] oo_stringAtIndex:0]] name];
                            eqKey = [[eqScripts oo_arrayAtIndex:primedEquipment] oo_stringAtIndex:0];
                            [UNIVERSE addMessage:OOExpandKey(@"equipment-primed", equipmentName) forCount:2.0];
                        }
                        [self doScriptEvent:OOJSID("playerChangedPrimedEquipment") withArgument:eqKey];
                    }
                    prime_equipment_pressed = YES;
                    
                }
                else  prime_equipment_pressed = NO;
                
                exceptionContext = @"activate equipment";
                // activate equipment 'n' - runs the activated() function inside the equipment's script.
                if ([self checkKeyPress:n_key_activate_equipment] || joyButtonState[BUTTON_ACTIVATEEQUIPMENT])
                {
                    if (!activate_equipment_pressed)
                    {
                        [self activatePrimableEquipment:primedEquipment withMode:OOPRIMEDEQUIP_ACTIVATED];
                    }
                    activate_equipment_pressed = YES;
                }
                else  activate_equipment_pressed = NO;
                
                exceptionContext = @"mode equipment";
                // mode equipment 'b' - runs the mode() function inside the equipment's script.
                if ([self checkKeyPress:n_key_mode_equipment] || joyButtonState[BUTTON_MODEEQUIPMENT])
                {
                    if (!mode_equipment_pressed)
                    {
                        [self activatePrimableEquipment:primedEquipment withMode:OOPRIMEDEQUIP_MODE];
                    }
                    mode_equipment_pressed = YES;
                }
                else  mode_equipment_pressed = NO;
 
                exceptionContext = @"fast equipment A";
                if ([self checkKeyPress:n_key_fastactivate_equipment_a] || joyButtonState[BUTTON_CLOAK])
                {
                    if (!fastactivate_a_pressed)
                    {
                        [self activatePrimableEquipment:[self eqScriptIndexForKey:[self fastEquipmentA]] withMode:OOPRIMEDEQUIP_ACTIVATED];
                    }
                    fastactivate_a_pressed = YES;
                }
                else fastactivate_a_pressed = NO;
 
                exceptionContext = @"fast equipment B";
                if ([self checkKeyPress:n_key_fastactivate_equipment_b] || joyButtonState[BUTTON_ENERGYBOMB])
                {
                    if (!fastactivate_b_pressed)
                    {
                        [self activatePrimableEquipment:[self eqScriptIndexForKey:[self fastEquipmentB]] withMode:OOPRIMEDEQUIP_ACTIVATED];
                    }
                    fastactivate_b_pressed = YES;
                }
                else fastactivate_b_pressed = NO;
 
                exceptionContext = @"custom equipment";
                // loop through all the objects in the customEquipActivation array
                NSDictionary *item;
                NSUInteger i;
                for (i = 0; i < [customEquipActivation count]; i++)
                {
                    item = [customEquipActivation objectAtIndex:i];
                    // check if the player has the equip item installed
                    if ([self hasOneEquipmentItem:[item oo_stringForKey:CUSTOMEQUIP_EQUIPKEY] includeWeapons:NO whileLoading:NO])
                    {
                        NSArray *key_act = [item oo_arrayForKey:CUSTOMEQUIP_KEYACTIVATE];
                        NSArray *key_mod = [item oo_arrayForKey:CUSTOMEQUIP_KEYMODE];
                        NSDictionary *but_act = [item oo_dictionaryForKey:CUSTOMEQUIP_BUTTONACTIVATE];
                        NSDictionary *but_mod = [item oo_dictionaryForKey:CUSTOMEQUIP_BUTTONMODE];
                        // if so, 
                        // check to see if the key or button was pressed for activate
                        if ((key_act && [self checkKeyPress:key_act]) || (but_act && [[OOJoystickManager sharedStickHandler] isButtonDown:[but_act oo_intForKey:STICK_AXBUT] stick:[but_act oo_intForKey:STICK_NUMBER]]))
                        {
                            if (![[customActivatePressed objectAtIndex:i] boolValue])
                            {
                                // initate the activate JS code
                                [self activatePrimableEquipment:[self eqScriptIndexForKey:[item oo_stringForKey:CUSTOMEQUIP_EQUIPKEY]] withMode:OOPRIMEDEQUIP_ACTIVATED];
                            }
                            [customActivatePressed replaceObjectAtIndex:i withObject:[NSNumber numberWithBool:YES]];
                        }
                        else [customActivatePressed replaceObjectAtIndex:i withObject:[NSNumber numberWithBool:NO]];
 
                        // check to see if the key or button was pressed for mode
                        if ((key_mod && [self checkKeyPress:key_mod]) || (but_mod && [[OOJoystickManager sharedStickHandler] isButtonDown:[but_mod oo_intForKey:STICK_AXBUT] stick:[but_mod oo_intForKey:STICK_NUMBER]]))
                        {
                            if (![[customModePressed objectAtIndex:i] boolValue])
                            {
                                // initiate the activate JS code
                                [self activatePrimableEquipment:[self eqScriptIndexForKey:[item oo_stringForKey:CUSTOMEQUIP_EQUIPKEY]] withMode:OOPRIMEDEQUIP_MODE];
                            }
                            [customModePressed replaceObjectAtIndex:i withObject:[NSNumber numberWithBool:YES]];
                        }
                        else [customModePressed replaceObjectAtIndex:i withObject:[NSNumber numberWithBool:NO]];
                    }
                }
 
                exceptionContext = @"incoming missile T";
                // target nearest incoming missile 'T' - useful for quickly giving a missile target to turrets
                if ([self checkKeyPress:n_key_target_incoming_missile] || joyButtonState[BUTTON_TARGETINCOMINGMISSILE])
                {
                    if (!target_incoming_missile_pressed)
                    {
                        [self targetNearestIncomingMissile];
                    }
                    target_incoming_missile_pressed = YES;
                }
                else  target_incoming_missile_pressed = NO;
                
                exceptionContext = @"missile T";
                //  shoot 't'   // switch on missile targeting
                if (([self checkKeyPress:n_key_target_missile] || joyButtonState[BUTTON_ARMMISSILE])&&(missile_entity[activeMissile]))
                {
                    // targeting 'on' here
                    if (!target_missile_pressed)
                    {
                        [self handleButtonTargetMissile];
                    }
                    target_missile_pressed = YES;
                }
                else  target_missile_pressed = NO;
                
                exceptionContext = @"missile U";
                //  shoot 'u'   // disarm missile targeting
                if ([self checkKeyPress:n_key_untarget_missile] || joyButtonState[BUTTON_UNARM])
                {
                    if (!safety_pressed)
                    {
                        //targeting off in both cases!
                        if ([self primaryTarget] != nil) [self noteLostTarget];
                        DESTROY(_primaryTarget);
                        [self safeAllMissiles];
                        if (!ident_engaged && [self weaponsOnline])
                        {
                            [UNIVERSE addMessage:DESC(@"missile-safe") forCount:2.0];
                            [self playMissileSafe];
                        }
                        else
                        {
                            [UNIVERSE addMessage:DESC(@"ident-off") forCount:2.0];
                            [self playIdentOff];
                        }
                        ident_engaged = NO;
                    }
                    safety_pressed = YES;
                }
                else  safety_pressed = NO;
                
                exceptionContext = @"ECM";
                //  shoot 'e'   // ECM
                if (([self checkKeyPress:n_key_ecm] || joyButtonState[BUTTON_ECM]) && [self hasECM])
                {
                    if (!ecm_in_operation)
                    {
                        if ([self weaponsOnline] && [self fireECM])
                        {
                            [self playFiredECMSound];
                            [UNIVERSE addMessage:DESC(@"ecm-on") forCount:3.0];
                        }
                    }
                }
                
            
                exceptionContext = @"escape pod";
                //  shoot 'escape'   // Escape pod launch - NOTE: Allowed at all times, but requires double press within a specific time interval.
                            // Double press not available in strict mode or when the "escape-pod-activation-immediate" override is in the 
                            // user defaults file.
                if (([self checkKeyPress:n_key_launch_escapepod] || joyButtonState[BUTTON_ESCAPE]) && [self hasEscapePod])
                {
                    BOOL    goodToLaunch = [[NSUserDefaults standardUserDefaults] boolForKey:@"escape-pod-activation-immediate"];
                    static  OOTimeDelta     escapePodKeyResetTime;
                    
                    if (!goodToLaunch)
                    {
                        if (!escapePodKey_pressed)
                        {
                            escapePodKey_pressed = YES;
                            // first keypress will unregister in KEY_REPEAT_INTERVAL seconds
                            escapePodKeyResetTime = [NSDate timeIntervalSinceReferenceDate] + KEY_REPEAT_INTERVAL;
                            //[gameView clearKey:key_launch_escapepod];
                            [gameView clearKey:[self getFirstKeyCode:n_key_launch_escapepod]];
                            if ([stickHandler joystickCount])
                            {
                                [stickHandler clearStickButtonState:BUTTON_ESCAPE];
                            }
                        }
                        else
                        {
                            OOTimeDelta timeNow = [NSDate timeIntervalSinceReferenceDate];
                            escapePodKey_pressed = NO;
                            if (timeNow < escapePodKeyResetTime)  goodToLaunch = YES;
                        }
                    }
                    if (goodToLaunch)
                    {
                        [self launchEscapeCapsule];
                    }
                }
                
                exceptionContext = @"dump cargo";
                //  shoot 'd'   // Dump Cargo
                if (([self checkKeyPress:n_key_dump_cargo] || joyButtonState[BUTTON_JETTISON]) && [cargo count] > 0)
                {
                    [self dumpCargo];
                }
                
                exceptionContext = @"rotate cargo";
                //  shoot 'R'   // Rotate Cargo
                if ([self checkKeyPress:n_key_rotate_cargo] || joyButtonState[BUTTON_ROTATECARGO])
                {
                    if ((!rotateCargo_pressed)&&([cargo count] > 0))
                        [self rotateCargo];
                    rotateCargo_pressed = YES;
                }
                else
                    rotateCargo_pressed = NO;
                
                exceptionContext = @"autopilot C";
                // autopilot 'c'
                if ([self checkKeyPress:n_key_autopilot] || joyButtonState[BUTTON_DOCKCPU])   // look for the 'c' key
                {
                    if ([self hasDockingComputer] && (!autopilot_key_pressed))
                    {
                        [self handleAutopilotOn:false];
                    }
                    autopilot_key_pressed = YES;
                }
                else
                    autopilot_key_pressed = NO;
                
                exceptionContext = @"autopilot shift-C";
                // autopilot 'C' - fast-autopilot
                if ([self checkKeyPress:n_key_autodock] || joyButtonState[BUTTON_DOCKCPUFAST])   // look for the 'C' key
                {
                    if ([self hasDockingComputer] && (!fast_autopilot_key_pressed))
                    {
                        [self handleAutopilotOn:true];
                    }
                    fast_autopilot_key_pressed = YES;
                }
                else
                {
                    fast_autopilot_key_pressed = NO;
                }
                
                exceptionContext = @"docking clearance request";
 
                if ([self checkKeyPress:n_key_docking_clearance_request] || joyButtonState[BUTTON_DOCKINGCLEARANCE])
                {
                    if (!docking_clearance_request_key_pressed)
                    {
                        Entity *primeTarget = [self primaryTarget];
                        [self performDockingRequest:(StationEntity*)primeTarget];
                    }
                    docking_clearance_request_key_pressed = YES;
                }
                else
                {
                    docking_clearance_request_key_pressed = NO;
                }
                
                exceptionContext = @"hyperspace";
                // hyperspace 'h'
                if ( ([self checkKeyPress:n_key_hyperspace] || joyButtonState[BUTTON_HYPERDRIVE]) &&
                      [self hasHyperspaceMotor] )   // look for the 'h' key
                {
                    if (!hyperspace_pressed)
                    {
                        if ([self status] == STATUS_WITCHSPACE_COUNTDOWN)
                        {
                            [self cancelWitchspaceCountdown];
                            if (galactic_witchjump)
                            {
                                galactic_witchjump = NO;
                                [UNIVERSE addMessage:DESC(@"witch-user-galactic-abort") forCount:3.0];
                            }
                            else
                            {
                                [UNIVERSE addMessage:DESC(@"witch-user-abort") forCount:3.0];
                            }
                        }
                        else if ([self witchJumpChecklist:false])
                        {
                            [self beginWitchspaceCountdown:hyperspaceMotorSpinTime];
                        }
                    }
                    hyperspace_pressed = YES;
                }
                else
                    hyperspace_pressed = NO;
                
                exceptionContext = @"galactic hyperspace";
                // Galactic hyperspace 'g'
                if (([self checkKeyPress:n_key_galactic_hyperspace] || joyButtonState[BUTTON_GALACTICDRIVE]) &&
                    ([self hasEquipmentItemProviding:@"EQ_GAL_DRIVE"]))// look for the 'g' key
                {
                    if (!galhyperspace_pressed)
                    {
                        if ([self status] == STATUS_WITCHSPACE_COUNTDOWN)
                        {
                            [self cancelWitchspaceCountdown];
                            if (galactic_witchjump)
                            {
                                galactic_witchjump = NO;
                                [UNIVERSE addMessage:DESC(@"witch-user-galactic-abort") forCount:3.0];
                            }
                            else
                            {
                                [UNIVERSE addMessage:DESC(@"witch-user-abort") forCount:3.0];
                            }
                        }
                        else
                        {
                            galactic_witchjump = YES;
                            
                            // even if we don't have a witchspace motor, we can still do a default galactic jump (!)
                            if(EXPECT([self hasHyperspaceMotor])) witchspaceCountdown = hyperspaceMotorSpinTime;
                            else witchspaceCountdown = DEFAULT_HYPERSPACE_SPIN_TIME;
                            
                            [self setStatus:STATUS_WITCHSPACE_COUNTDOWN];
                            [self playGalacticHyperspace];
                            // say it!
                            [UNIVERSE addMessage:[NSString stringWithFormat:DESC(@"witch-galactic-in-f-seconds"), witchspaceCountdown] forCount:1.0];
                            // FIXME: how to preload target system for hyperspace jump?
                            
                            [self doScriptEvent:OOJSID("playerStartedJumpCountdown")
                                  withArguments:[NSArray arrayWithObjects:@"galactic", [NSNumber numberWithFloat:witchspaceCountdown], nil]];
                        }
                    }
                    galhyperspace_pressed = YES;
                }
                else
                    galhyperspace_pressed = NO;
 
            }
 
#if OO_FOV_INFLIGHT_CONTROL_ENABLED
            // Field of view controls
            if (![UNIVERSE displayGUI])
            {
                if (([self checkKeyPress:n_key_inc_field_of_view] || joyButtonState[BUTTON_INC_FIELD_OF_VIEW]) && (fieldOfView < MAX_FOV))
                {
                    fieldOfView *= pow(fov_delta, delta_t);
                    if (fieldOfView > MAX_FOV)  fieldOfView = MAX_FOV;
                }
 
                if (([self checkKeyPress:n_key_dec_field_of_view] || joyButtonState[BUTTON_DEC_FIELD_OF_VIEW]) && (fieldOfView > MIN_FOV))
                {
                    fieldOfView /= pow(fov_delta, delta_t);
                    if (fieldOfView < MIN_FOV)  fieldOfView = MIN_FOV;
                }
 
                NSDictionary *functionForFovAxis = [[stickHandler axisFunctions] oo_dictionaryForKey:[[NSNumber numberWithInt:AXIS_FIELD_OF_VIEW] stringValue]];
                if ([stickHandler joystickCount] != 0 && functionForFovAxis != nil)
                {
                    // TODO think reqFov through
                    double reqFov = [stickHandler getAxisState: AXIS_FIELD_OF_VIEW];
                    if (fieldOfView < maxFieldOfView * reqFov)
                    {
                        fieldOfView *= pow(fov_delta, delta_t);
                        if (fieldOfView > MAX_FOV)  fieldOfView = MAX_FOV;
                    }
                    if (fieldOfView > maxFieldOfView * reqFov)
                    {
                        fieldOfView /= pow(fov_delta, delta_t);
                        if (fieldOfView < MIN_FOV)  fieldOfView = MIN_FOV;
                    }
                }
            }
#endif
 
    #ifndef NDEBUG
            exceptionContext = @"dump target state";
            if ([self checkKeyPress:n_key_dump_target_state])
            {
                if (!dump_target_state_pressed)
                {
                    dump_target_state_pressed = YES;
                    id target = [self primaryTarget];
                    if (target == nil)  target = self;
                    [target dumpState];
                }
            }
            else  dump_target_state_pressed = NO;
    #endif
            
            //  text displays
            exceptionContext = @"pollGuiScreenControls";
            [self pollGuiScreenControls];
        }
        else
        {
            // game is paused
            // check options menu request
            exceptionContext = @"options menu";
            if (([self checkKeyPress:n_key_gui_screen_options]) && (gui_screen != GUI_SCREEN_OPTIONS) && ![gameView allowingStringInput])
            {
                [gameView clearKeys];
                [self setGuiToLoadSaveScreen];
            }
            
            #if (ALLOW_CUSTOM_VIEWS_WHILE_PAUSED)
            [self pollCustomViewControls];  // allow custom views during pause
            #endif
            
            if (gui_screen == GUI_SCREEN_OPTIONS || gui_screen == GUI_SCREEN_GAMEOPTIONS || gui_screen == GUI_SCREEN_STICKMAPPER || 
                gui_screen == GUI_SCREEN_STICKPROFILE || gui_screen == GUI_SCREEN_KEYBOARD || gui_screen == GUI_SCREEN_KEYBOARD_CONFIRMCLEAR ||
                gui_screen == GUI_SCREEN_KEYBOARD_CONFIG || gui_screen == GUI_SCREEN_KEYBOARD_ENTRY || gui_screen == GUI_SCREEN_KEYBOARD_LAYOUT)
            {
                if ([UNIVERSE pauseMessageVisible]) [[UNIVERSE messageGUI] leaveLastLine];
                else [[UNIVERSE messageGUI] clear];
                NSTimeInterval  time_this_frame = [NSDate timeIntervalSinceReferenceDate];
                OOTimeDelta     time_delta;
                if (![[GameController sharedController] isGamePaused])
                {
                    time_delta = time_this_frame - time_last_frame;
                    time_last_frame = time_this_frame;
                    time_delta = OOClamp_0_max_d(time_delta, MINIMUM_GAME_TICK);
                }
                else
                {
                    time_delta = 0.0;
                }
                
                script_time += time_delta;
                [self pollGuiArrowKeyControls:time_delta];
            }
            
            exceptionContext = @"debug keys";
    #ifndef NDEBUG
            // look for debugging keys
            if ([self checkKeyPress:n_key_dump_entity_list] && ![gameView allowingStringInput])// look for the '0' key
            {
                if (!dump_entity_list_pressed)
                {
                    [UNIVERSE debugDumpEntities];
                    gDebugFlags = 0;
                    [UNIVERSE addMessage:@"Entity List dumped. Debugging OFF" forCount:3];
                }
                dump_entity_list_pressed = YES;
            }
            else
                dump_entity_list_pressed = NO;
            
            // look for debugging keys
            if ([self checkKeyPress:n_key_debug_full] && ![gameView allowingStringInput])// look for the 'd' key
            {
                gDebugFlags = DEBUG_ALL;
                [UNIVERSE addMessage:@"Full debug ON" forCount:3];
            }
            
            if ([self checkKeyPress:n_key_debug_collision] && ![gameView allowingStringInput])// look for the 'b' key
            {
                gDebugFlags |= DEBUG_COLLISIONS;
                [UNIVERSE addMessage:@"Collision debug ON" forCount:3];
            }
            
            if ([self checkKeyPress:n_key_debug_console_connect] && ![[OODebugMonitor sharedDebugMonitor] usingPlugInController] && ![gameView allowingStringInput]) // look for the 'c' key
            {
                // This code is executed only if we're not using the integrated plugin controller
                if (!autopilot_key_pressed)
                {
                    if (![[OODebugMonitor sharedDebugMonitor] debuggerConnected])
                    {
                        OOInitDebugSupport();
                        if ([[OODebugMonitor sharedDebugMonitor] debuggerConnected])
                            [UNIVERSE addMessage:@"Connected to debug console." forCount:3];
                    }
                    else
                    {
                        [[OODebugMonitor sharedDebugMonitor] setDebugger:nil];
                        [UNIVERSE addMessage:@"Disconnected from debug console." forCount:3];
                    }
                }
                autopilot_key_pressed = YES;
            }
            else
                autopilot_key_pressed = NO;
            
            if ([self checkKeyPress:n_key_debug_bounding_boxes] && ![gameView allowingStringInput])// look for the 'x' key
            {
                gDebugFlags |= DEBUG_BOUNDING_BOXES;
                [UNIVERSE addMessage:@"Bounding box debug ON" forCount:3];
            }
            
            if ([self checkKeyPress:n_key_debug_shaders] && ![gameView allowingStringInput])// look for the 's' key
            {
                OOLogSetDisplayMessagesInClass(@"$shaderDebugOn", YES);
                [UNIVERSE addMessage:@"Shader debug ON" forCount:3];
            }
 
            if (([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_arrow_right]) && gui_screen != GUI_SCREEN_GAMEOPTIONS && [UNIVERSE displayFPS] && ![gameView allowingStringInput])
            {
                if (!leftRightKeyPressed)
                {
                    float newTimeAccelerationFactor = [self checkKeyPress:n_key_gui_arrow_left] ?
                            fmax([UNIVERSE timeAccelerationFactor] / 2.0f, TIME_ACCELERATION_FACTOR_MIN) :
                            fmin([UNIVERSE timeAccelerationFactor] * 2.0f, TIME_ACCELERATION_FACTOR_MAX);
                    [UNIVERSE setTimeAccelerationFactor:newTimeAccelerationFactor];
                }
                leftRightKeyPressed = YES;
            }
            else
                leftRightKeyPressed = NO;
                    
            
            if ([self checkKeyPress:n_key_debug_off] && ![gameView allowingStringInput])// look for the 'n' key
            {
                gDebugFlags = 0;
                [UNIVERSE addMessage:@"All debug flags OFF" forCount:3];
                OOLogSetDisplayMessagesInClass(@"$shaderDebugOn", NO);
            }
    #endif
        }
        
        exceptionContext = @"pause";
        // Pause game 'p'
        if (([self checkKeyPress:n_key_pausebutton] || joyButtonState[BUTTON_PAUSE]) && gui_screen != GUI_SCREEN_LONG_RANGE_CHART && gui_screen != GUI_SCREEN_MISSION && ![gameView allowingStringInput])// look for the 'p' key
        {
            if (!pause_pressed)
            {
                if (paused)
                {
                    script_time = saved_script_time;
                    // Reset to correct GUI screen, if we are unpausing from one.
                    // Don't set gui_screen here, use setGuis - they also switch backgrounds.
                    // No gui switching events will be triggered while still paused.
                    switch (saved_gui_screen)
                    {
                        case GUI_SCREEN_STATUS:
                            [self setGuiToStatusScreen];
                            break;
                        case GUI_SCREEN_LONG_RANGE_CHART:
                            [self setGuiToLongRangeChartScreen];
                            break;
                        case GUI_SCREEN_SHORT_RANGE_CHART:
                            [self setGuiToShortRangeChartScreen];
                            break;
                        case GUI_SCREEN_MANIFEST:
                            [self setGuiToManifestScreen];
                            break;
                        case GUI_SCREEN_MARKET:
                            [self setGuiToMarketScreen];
                            break;
                        case GUI_SCREEN_MARKETINFO:
                            [self setGuiToMarketInfoScreen];
                            break;
                        case GUI_SCREEN_SYSTEM_DATA:
                            // Do not reset planet rotation if we are already in the system info screen!
                            if (gui_screen != GUI_SCREEN_SYSTEM_DATA)
                                [self setGuiToSystemDataScreen];
                            break;
                        default:
                            gui_screen = saved_gui_screen;  // make sure we're back to the right screen
                            break;
                    }
                    [gameView allowStringInput:NO];
                    [UNIVERSE clearPreviousMessage];
                    [UNIVERSE setViewDirection:saved_view_direction];
                    currentWeaponFacing = saved_weapon_facing;
                    // make sure the light comes from the right direction after resuming from pause!
                    if (saved_gui_screen == GUI_SCREEN_SYSTEM_DATA) [UNIVERSE setMainLightPosition:_sysInfoLight];
                    [[UNIVERSE gui] setForegroundTextureKey:@"overlay"];
                    [[UNIVERSE gameController] setGamePaused:NO];
                }
                else
                {
                    saved_view_direction = [UNIVERSE viewDirection];
                    saved_script_time = script_time;
                    saved_gui_screen = gui_screen;
                    saved_weapon_facing = currentWeaponFacing;
                    [UNIVERSE pauseGame];   // pause handler
                }
            }
            pause_pressed = YES;
        }
        else
        {
            pause_pressed = NO;
        }
    }
    @catch (NSException *exception)
    {
        OOLog(kOOLogException, @"***** Exception in pollFlightControls [%@]: %@ : %@", exceptionContext, [exception name], [exception reason]);
    }
}

Referenced by PlayerEntity(OOControlsPrivate)::handleAutopilotOn:.

Here is the caller graph for this function:

pollGameOverControls:

- (void) pollGameOverControls: (double)  delta_t

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

                             :(double)delta_t
{
    MyOpenGLView  *gameView = [UNIVERSE gameView];
    if ([gameView isDown:32])   // look for the spacebar
    {
        if (!spacePressed)
        {
            [UNIVERSE displayMessage:@"" forCount:1.0];
            shot_time = INITIAL_SHOT_TIME;  // forces immediate restart
        }
        spacePressed = YES;
    }
    else
        spacePressed = NO;
}

pollGuiArrowKeyControls:

- (void) pollGuiArrowKeyControls: (double)  delta_t

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

                                :(double) delta_t
{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    BOOL            moving = NO;
    BOOL            dragging = NO;
    double          cursor_speed = ([gameView isCtrlDown] ? 20.0 : 10.0)* chart_zoom;
    GameController  *controller = [UNIVERSE gameController];
    GuiDisplayGen   *gui = [UNIVERSE gui];
    GUI_ROW_INIT(gui);
    
    // deal with string inputs as necessary
    if (gui_screen == GUI_SCREEN_LONG_RANGE_CHART)
    {
        [gameView setStringInput: gvStringInputAlpha];
    }
    else if (gui_screen == GUI_SCREEN_SAVE)
    {
        [gameView setStringInput: gvStringInputLoadSave];
    }
    else if (gui_screen == GUI_SCREEN_MISSION && _missionTextEntry)
    {
        [gameView setStringInput: gvStringInputAll];
    }
    else if (gui_screen == GUI_SCREEN_KEYBOARD_ENTRY)
    {
        [gameView setStringInput: gvStringInputAll];
    }
#if 0
    // at the moment this function is never called for GUI_SCREEN_OXZMANAGER
    // but putting this here in case we do later
    else if (gui_screen == GUI_SCREEN_OXZMANAGER && [[OOOXZManager sharedManager] isAcceptingTextInput])
    {
        [gameView setStringInput: gvStringInputAll];
    }
#endif
    else
    {
        [gameView allowStringInput: NO];
        // If we have entered this screen with the injectors key pressed, make sure
        // that injectors switch off when we release it - Nikos.
        if (afterburner_engaged && ![self checkKeyPress:n_key_inject_fuel])
        {
            afterburner_engaged = NO;
        }
            
    }
    
    switch (gui_screen)
    {
        case GUI_SCREEN_LONG_RANGE_CHART:
 
            if ([self status] != STATUS_WITCHSPACE_COUNTDOWN)
            {
                if ([[gameView typedString] length] > 0)
                {
                    planetSearchString = [[[gameView typedString] lowercaseString] retain];
                    NSPoint search_coords = [UNIVERSE findSystemCoordinatesWithPrefix:planetSearchString];
                    if ((search_coords.x >= 0.0)&&(search_coords.y >= 0.0))
                    {
                        // always reset the found system index at the beginning of a new search
                        if ([planetSearchString length] == 1) [[UNIVERSE gui] targetNextFoundSystem:0];
                        
                        // Always select the right one out of 2 overlapping systems.
                        [self targetNewSystem:0 whileTyping:YES];
                    }
                    else
                    {
                        found_system_id = -1;
                        [self clearPlanetSearchString];
                    }
                }
                else
                {
                    if ([gameView isDown:gvDeleteKey]) // did we just delete the string ?
                    {
                        found_system_id = -1;
                        [UNIVERSE findSystemCoordinatesWithPrefix:@""];
                    }
                    if (planetSearchString) [planetSearchString release];
                    planetSearchString = nil;
                }
                
                moving |= (searchStringLength != [[gameView typedString] length]);
                searchStringLength = [[gameView typedString] length];
            }
 
        case GUI_SCREEN_SHORT_RANGE_CHART:
 
            if ([self checkKeyPress:n_key_chart_highlight])
            {
                if (!queryPressed)
                {
                    OOLongRangeChartMode mode = [self longRangeChartMode];
                    if (mode != OOLRC_MODE_TECHLEVEL)
                    {
                        [self setLongRangeChartMode:mode+1];
                    }
                    else
                    {
                        [self setLongRangeChartMode:OOLRC_MODE_SUNCOLOR];
                    }
                    [self doScriptEvent:OOJSID("chartHighlightModeChanged") withArgument:OOStringFromLongRangeChartMode([self longRangeChartMode])];
                }
                queryPressed = YES;
            }
            else
            {
                queryPressed = NO;
            }
            
            if ([self checkKeyPress:n_key_map_info] && chart_zoom <= CHART_ZOOM_SHOW_LABELS)
            {
                if (!chartInfoPressed)
                {
                    show_info_flag = !show_info_flag;
                    chartInfoPressed = YES;
                }
            }
            else
            {
                chartInfoPressed = NO;
            }
            
            if ([self status] != STATUS_WITCHSPACE_COUNTDOWN)
            {
                if ([self hasEquipmentItemProviding:@"EQ_ADVANCED_NAVIGATIONAL_ARRAY"])
                {
                    if ([self checkKeyPress:n_key_advanced_nav_array_next] || [self checkKeyPress:n_key_advanced_nav_array_previous])
                    {
                        if (!pling_pressed)
                        {
                            if ([self checkKeyPress:n_key_advanced_nav_array_previous])
                            {
                                switch (ANA_mode)
                                {
                                case OPTIMIZED_BY_NONE: ANA_mode = OPTIMIZED_BY_TIME;   break;
                                case OPTIMIZED_BY_TIME: ANA_mode = OPTIMIZED_BY_JUMPS;  break;
                                default:        ANA_mode = OPTIMIZED_BY_NONE;   break;
                                }
                            }
                            else
                            {
                                switch (ANA_mode)
                                {
                                case OPTIMIZED_BY_NONE: ANA_mode = OPTIMIZED_BY_JUMPS;  break;
                                case OPTIMIZED_BY_JUMPS:ANA_mode = OPTIMIZED_BY_TIME;   break;
                                default:        ANA_mode = OPTIMIZED_BY_NONE;   break;
                                }
                            }
                            if (ANA_mode == OPTIMIZED_BY_NONE || ![self infoSystemOnRoute])
                            {
                                [self setInfoSystemID: target_system_id moveChart: NO];
                            }
                        }
                        pling_pressed = YES;
                    }
                    else
                    {
                        pling_pressed = NO;
                    }
                }
                else
                {
                    ANA_mode = OPTIMIZED_BY_NONE;
                }
 
                if ([gameView isDown:gvMouseDoubleClick])
                {
                    [gameView clearMouse];
                    mouse_left_down = NO;
                    [self noteGUIWillChangeTo:GUI_SCREEN_SYSTEM_DATA];
                    showingLongRangeChart = (gui_screen == GUI_SCREEN_LONG_RANGE_CHART);
                    [self setGuiToSystemDataScreen];
                    break;
                }
                if ([gameView isDown:gvMouseLeftButton])
                {
                    NSPoint maus = [gameView virtualJoystickPosition];
                    double vadjust = MAIN_GUI_PIXEL_HEIGHT/2.0 - CHART_SCREEN_VERTICAL_CENTRE;
                    double hscale = MAIN_GUI_PIXEL_WIDTH / (64.0 * chart_zoom);
                    double vscale = MAIN_GUI_PIXEL_HEIGHT / (128.0 * chart_zoom);
                    if (mouse_left_down == NO)
                    {
                        NSPoint centre = [self adjusted_chart_centre];
                        centre_at_mouse_click = chart_centre_coordinates;
                        mouse_click_position = maus;
                        chart_focus_coordinates.x = OOClamp_0_max_f(centre.x + (maus.x * MAIN_GUI_PIXEL_WIDTH) / hscale, 256.0);
                        chart_focus_coordinates.y = OOClamp_0_max_f(centre.y + (maus.y * MAIN_GUI_PIXEL_HEIGHT + vadjust) / vscale, 256.0);
                        target_chart_focus = chart_focus_coordinates;
                    }
                    if (fabs(maus.x - mouse_click_position.x)*MAIN_GUI_PIXEL_WIDTH > 2 ||
                        fabs(maus.y - mouse_click_position.y)*MAIN_GUI_PIXEL_HEIGHT > 2)
                    {
                        chart_centre_coordinates.x = OOClamp_0_max_f(centre_at_mouse_click.x - (maus.x - mouse_click_position.x)*MAIN_GUI_PIXEL_WIDTH/hscale, 256.0);
                        chart_centre_coordinates.y = OOClamp_0_max_f(centre_at_mouse_click.y - (maus.y - mouse_click_position.y)*MAIN_GUI_PIXEL_HEIGHT/vscale, 256.0);
                        target_chart_centre = chart_centre_coordinates;
                        dragging = YES;
                    }
                    if (gui_screen == GUI_SCREEN_LONG_RANGE_CHART)
                        [gameView resetTypedString];
                    mouse_left_down = YES;
                }
                else if (mouse_left_down == YES) 
                {
                    NSPoint maus = [gameView virtualJoystickPosition];
                    if (fabs(maus.x - mouse_click_position.x)*MAIN_GUI_PIXEL_WIDTH <= 2 &&
                        fabs(maus.y - mouse_click_position.y)*MAIN_GUI_PIXEL_HEIGHT <= 2)
                    {
                        cursor_coordinates = chart_focus_coordinates;
                        moving = YES;
                    }
                    else
                    {
                        dragging = YES;
                    }
                    mouse_left_down = NO;
                }
                if ([self checkKeyPress:n_key_map_home])
                {
                    if ([gameView isOptDown])
                    {
                        [self homeInfoSystem];
                        target_chart_focus = galaxy_coordinates;
                    }
                    else
                    {
                        [gameView resetTypedString];
                        cursor_coordinates = galaxy_coordinates;
                        target_chart_focus = cursor_coordinates;
                        target_chart_centre = galaxy_coordinates;
                        found_system_id = -1;
                        [UNIVERSE findSystemCoordinatesWithPrefix:@""];
                        moving = YES;
                    }
                }
                if ([self checkKeyPress:n_key_map_end])
                {
                    [self targetInfoSystem];
                    target_chart_focus = cursor_coordinates;
                }
                if ([self checkKeyPress:n_key_map_zoom_in] || [gameView mouseWheelState] == gvMouseWheelDown)
                {
                    target_chart_zoom *= CHART_ZOOM_SPEED_FACTOR;
                    if (target_chart_zoom > CHART_MAX_ZOOM) target_chart_zoom = CHART_MAX_ZOOM;
                    saved_chart_zoom = target_chart_zoom;
                }
                if ([self checkKeyPress:n_key_map_zoom_out] || [gameView mouseWheelState] == gvMouseWheelUp)
                {
                    if (gui_screen == GUI_SCREEN_LONG_RANGE_CHART)
                    {
                        target_chart_zoom = CHART_MAX_ZOOM;
                        [self setGuiToShortRangeChartScreen];
                    }
                    target_chart_zoom /= CHART_ZOOM_SPEED_FACTOR;
                    if (target_chart_zoom < 1.0) target_chart_zoom = 1.0;
                    saved_chart_zoom = target_chart_zoom;
                    //target_chart_centre = cursor_coordinates;
                    target_chart_focus = target_chart_centre;
                }
                
                BOOL nextSystem = [gameView isShiftDown];
                BOOL nextSystemOnRoute = [gameView isOptDown];
                
                if ([self checkNavKeyPress:n_key_gui_arrow_left])
                {
                    if ((nextSystem || nextSystemOnRoute) && pressedArrow != 1)
                    {
                        if (nextSystem)
                        {
                            [self targetNewSystem:-1];
                            target_chart_focus = cursor_coordinates;
                        }
                        else
                        {
                            [self clearPlanetSearchString];
                            [self previousInfoSystem];
                            target_chart_focus = [[UNIVERSE systemManager] getCoordinatesForSystem:info_system_id inGalaxy:galaxy_number];
                        }
                        pressedArrow = 1;
                    }
                    else if (!nextSystem && !nextSystemOnRoute)
                    {
                        [gameView resetTypedString];
                        cursor_coordinates.x -= cursor_speed*delta_t;
                        if (cursor_coordinates.x < 0.0) cursor_coordinates.x = 0.0;
                        moving = YES;
                        target_chart_focus = cursor_coordinates;
                    }
                }
                else
                    pressedArrow =  pressedArrow == 1 ? 0 : pressedArrow;
                
                if ([self checkNavKeyPress:n_key_gui_arrow_right])
                {
                    if ((nextSystem || nextSystemOnRoute) && pressedArrow != 2)
                    {
                        if (nextSystem)
                        {
                            [self targetNewSystem:+1];
                            target_chart_focus = cursor_coordinates;
                        }
                        else
                        {
                            [self clearPlanetSearchString];
                            [self nextInfoSystem];
                            target_chart_focus = [[UNIVERSE systemManager] getCoordinatesForSystem:info_system_id inGalaxy:galaxy_number];
                        }
                        pressedArrow = 2;
                    }
                    else if (!nextSystem && !nextSystemOnRoute)
                    {
                        [gameView resetTypedString];
                        cursor_coordinates.x += cursor_speed*delta_t;
                        if (cursor_coordinates.x > 256.0) cursor_coordinates.x = 256.0;
                        moving = YES;
                        target_chart_focus = cursor_coordinates;
                    }
                }
                else
                    pressedArrow =  pressedArrow == 2 ? 0 : pressedArrow;
                
                if ([self checkNavKeyPress:n_key_gui_arrow_down])
                {
                    if (nextSystem && pressedArrow != 3)
                    {
                        [self targetNewSystem:+1];
                        pressedArrow = 3;
                    }
                    else if (!nextSystem)
                    {
                        [gameView resetTypedString];
                        cursor_coordinates.y += cursor_speed*delta_t*2.0;
                        if (cursor_coordinates.y > 256.0) cursor_coordinates.y = 256.0;
                        moving = YES;
                    }
                    target_chart_focus = cursor_coordinates;
                }
                else
                    pressedArrow =  pressedArrow == 3 ? 0 : pressedArrow;
                
                if ([self checkNavKeyPress:n_key_gui_arrow_up])
                {
                    if (nextSystem && pressedArrow != 4)
                    {
                        [self targetNewSystem:-1];
                        pressedArrow = 4;
                    }   
                    else if (!nextSystem)
                    {
                        [gameView resetTypedString];
                        cursor_coordinates.y -= cursor_speed*delta_t*2.0;
                        if (cursor_coordinates.y < 0.0) cursor_coordinates.y = 0.0;
                        moving = YES;
                    }
                    target_chart_focus = cursor_coordinates;
                }
                else
                    pressedArrow =  pressedArrow == 4 ? 0 : pressedArrow;
                if ((cursor_moving)&&(!moving))
                {
                    if (found_system_id == -1)
                    {
                        target_system_id = [UNIVERSE findSystemNumberAtCoords:cursor_coordinates withGalaxy:galaxy_number includingHidden:NO];
                        [self setInfoSystemID: target_system_id moveChart: YES];
                    }
                    else
                    {
                        // if found with a search string, don't recalculate! Required for overlapping systems, like Divees & Tezabi in galaxy 5
                        NSPoint fpos = [[UNIVERSE systemManager] getCoordinatesForSystem:found_system_id inGalaxy:galaxy_number];
                        if (fpos.x != cursor_coordinates.x && fpos.y != cursor_coordinates.y)
                        {
                            target_system_id = [UNIVERSE findSystemNumberAtCoords:cursor_coordinates withGalaxy:galaxy_number includingHidden:NO];
                            [self setInfoSystemID: target_system_id moveChart: YES];
                        }
                    }
                    cursor_coordinates = [[UNIVERSE systemManager] getCoordinatesForSystem:target_system_id inGalaxy:galaxy_number];
                }
                if (chart_focus_coordinates.x - target_chart_centre.x <= -CHART_SCROLL_AT_X*chart_zoom)
                {
                    target_chart_centre.x = chart_focus_coordinates.x + CHART_SCROLL_AT_X*chart_zoom;
                }
                else if (chart_focus_coordinates.x - target_chart_centre.x >= CHART_SCROLL_AT_X*chart_zoom)
                {
                    target_chart_centre.x = chart_focus_coordinates.x - CHART_SCROLL_AT_X*chart_zoom;
                }
                if (chart_focus_coordinates.y - target_chart_centre.y <= -CHART_SCROLL_AT_Y*chart_zoom)
                {
                    target_chart_centre.y = chart_focus_coordinates.y + CHART_SCROLL_AT_Y*chart_zoom;
                }
                else if (chart_focus_coordinates.y - target_chart_centre.y >= CHART_SCROLL_AT_Y*chart_zoom)
                {
                    target_chart_centre.y = chart_focus_coordinates.y - CHART_SCROLL_AT_Y*chart_zoom;
                }
                chart_centre_coordinates.x = (3.0*chart_centre_coordinates.x + target_chart_centre.x)/4.0;
                chart_centre_coordinates.y = (3.0*chart_centre_coordinates.y + target_chart_centre.y)/4.0;
                chart_zoom = (3.0*chart_zoom + target_chart_zoom)/4.0;
                chart_focus_coordinates.x = (3.0*chart_focus_coordinates.x + target_chart_focus.x)/4.0;
                chart_focus_coordinates.y = (3.0*chart_focus_coordinates.y + target_chart_focus.y)/4.0;
                if (cursor_moving || dragging) [self setGuiToChartScreenFrom: gui_screen]; // update graphics
                cursor_moving = moving;
            }
            break;
            
        case GUI_SCREEN_SYSTEM_DATA:
            if ([self checkKeyPress:n_key_system_next_system])
            {
                if (!next_planet_info_pressed)
                {
                    [self nextInfoSystem];
                    next_planet_info_pressed = YES;
                }
            }
            else
            {
                next_planet_info_pressed = NO;
            }
            if ([self checkKeyPress:n_key_system_previous_system])
            {
                if (!previous_planet_info_pressed)
                {
                    [self previousInfoSystem];
                    previous_planet_info_pressed = YES;
                }
            }
            else
            {
                previous_planet_info_pressed = NO;
            }
            if ([self checkKeyPress:n_key_system_home])
            {
                if (!home_info_pressed)
                {
                    [self homeInfoSystem];
                    home_info_pressed = YES;
                }
            }
            else
            {
                home_info_pressed = NO;
            }
            if ([self checkKeyPress:n_key_system_end])
            {
                if (!target_info_pressed)
                {
                    [self targetInfoSystem];
                    target_info_pressed = YES;
                }
            }
            else
            {
                target_info_pressed = NO;
            }
            break;
            
#if OO_USE_CUSTOM_LOAD_SAVE
            // DJS: Farm off load/save screen options to LoadSave.m
        case GUI_SCREEN_LOAD:
        {
            NSString *commanderFile = [self commanderSelector];
            if(commanderFile)
            {
                // also release the demo ship here (see showShipyardModel and noteGUIDidChangeFrom)
                [demoShip release];
                demoShip = nil;
                
                [self loadPlayerFromFile:commanderFile asNew:NO];
            }
            break;
        }
            
        case GUI_SCREEN_SAVE:
            [self pollGuiScreenControlsWithFKeyAlias:NO];
            /* Only F1 works for launch on this screen, not '1' or
             * whatever it has been bound to */
            if ([self checkKeyPress:n_key_launch_ship fKey_only:YES])  [self handleUndockControl];
            if (gui_screen == GUI_SCREEN_SAVE)
            {
                [self saveCommanderInputHandler];
            }
            else pollControls = YES;
            break;
            
        case GUI_SCREEN_SAVE_OVERWRITE:
            [self overwriteCommanderInputHandler];
            break;
#endif
            
        case GUI_SCREEN_STICKMAPPER:
            [self handleStickMapperScreenKeys];
            break;
        
        case GUI_SCREEN_STICKPROFILE:
            [self stickProfileInputHandler: gui view: gameView];
            break;
            
        case GUI_SCREEN_GAMEOPTIONS:
            [self handleGameOptionsScreenKeys];
            break;
 
        case GUI_SCREEN_KEYBOARD:
            [self handleKeyMapperScreenKeys];
            //if ([gameView isDown:' '])
            //{
            //  [self setGuiToGameOptionsScreen];
            //}
            break;
 
        case GUI_SCREEN_KEYBOARD_CONFIRMCLEAR:
            [self handleKeyMapperConfirmClearKeys:gui view:gameView];
            break;
 
        case GUI_SCREEN_KEYBOARD_CONFIG:
            [self handleKeyConfigKeys:gui view:gameView];
            break;
 
        case GUI_SCREEN_KEYBOARD_ENTRY:
            [self handleKeyConfigEntryKeys:gui view:gameView];
            break;
 
        case GUI_SCREEN_KEYBOARD_LAYOUT:
            [self handleKeyboardLayoutKeys];
            break;
 
        case GUI_SCREEN_SHIPLIBRARY:
            if ([gameView isDown:' '])  //  '<space>'
            {
                // viewed in game, return to interfaces as that's where it's accessed from
                [self setGuiToInterfacesScreen:0];
            }
            if ([self checkKeyPress:n_key_gui_arrow_up]) //  '<--'
            {
                if (!upDownKeyPressed)
                    [UNIVERSE selectIntro2Previous];
            }
            if ([self checkKeyPress:n_key_gui_arrow_down]) //  '-->'
            {
                if (!upDownKeyPressed)
                    [UNIVERSE selectIntro2Next];
            }
            upDownKeyPressed = (([self checkKeyPress:n_key_gui_arrow_up])||([self checkKeyPress:n_key_gui_arrow_down]));
 
            if ([self checkKeyPress:n_key_gui_arrow_left]) //  '<--'
            {
                if (!leftRightKeyPressed)
                    [UNIVERSE selectIntro2PreviousCategory];
            }
            if ([self checkKeyPress:n_key_gui_arrow_right]) //  '-->'
            {
                if (!leftRightKeyPressed)
                    [UNIVERSE selectIntro2NextCategory];
            }
            leftRightKeyPressed = (([self checkKeyPress:n_key_gui_arrow_left])||([self checkKeyPress:n_key_gui_arrow_right]));
 
            break;
        case GUI_SCREEN_OPTIONS:
            [self handleGUIUpDownArrowKeys];
            OOGUIRow guiSelectedRow = [gui selectedRow];
            BOOL selectKeyPress = ([self checkKeyPress:n_key_gui_select]||[gameView isDown:gvMouseDoubleClick]);
 
            if (selectKeyPress)   // 'enter'
            {
                if ((guiSelectedRow == GUI_ROW(,QUICKSAVE))&&(!disc_operation_in_progress))
                {
                    @try
                    {
                        disc_operation_in_progress = YES;
                        [self quicksavePlayer];
                    }
                    @catch (NSException *exception)
                    {
                        OOLog(kOOLogException, @"\n\n***** Handling exception: %@ : %@ *****\n\n",[exception name], [exception reason]);
                        if ([[exception name] isEqual:@"GameNotSavedException"])    // try saving game instead
                        {
                            OOLog(kOOLogException, @"%@", @"\n\n***** Trying a normal save instead *****\n\n");
                            if ([controller inFullScreenMode])
                                [controller pauseFullScreenModeToPerform:@selector(savePlayer) onTarget:self];
                            else
                                [self savePlayer];
                        }
                        else
                        {
                            @throw exception;
                        }
                    }
                }
                if ((guiSelectedRow == GUI_ROW(,SAVE))&&(!disc_operation_in_progress))
                {
                    disc_operation_in_progress = YES;
                    [self savePlayer];
                }
                if ((guiSelectedRow == GUI_ROW(,LOAD))&&(!disc_operation_in_progress))
                {
                    disc_operation_in_progress = YES;
                    if (![self loadPlayer])
                    {
                        disc_operation_in_progress = NO;
                        [self setGuiToStatusScreen];
                    }
                }
                
                
                if ((guiSelectedRow == GUI_ROW(,BEGIN_NEW))&&(!disc_operation_in_progress))
                {
                    disc_operation_in_progress = YES;
                    [UNIVERSE setUseAddOns:SCENARIO_OXP_DEFINITION_ALL fromSaveGame:NO forceReinit:YES]; // calls reinitAndShowDemo
                }
                
                if ([gameView isDown:gvMouseDoubleClick])
                    [gameView clearMouse];
            }
            else
            {
                disc_operation_in_progress = NO;
            }
            
#if OOLITE_SDL
            // quit only appears in GNUstep as users aren't
            // used to Cmd-Q equivs. Same goes for window
            // vs fullscreen.
            if ((guiSelectedRow == GUI_ROW(,QUIT)) && selectKeyPress)
            {
                [[UNIVERSE gameController] exitAppWithContext:@"Exit Game selected on options screen"];
            }
#endif
            
            if ((guiSelectedRow == GUI_ROW(,GAMEOPTIONS)) && selectKeyPress)
            {
                [gameView clearKeys];
                [self setGuiToGameOptionsScreen];
            }
            
            break;
            
        case GUI_SCREEN_EQUIP_SHIP:
            if ([self handleGUIUpDownArrowKeys])
            {
                NSString        *itemText = [gui selectedRowText];
                OOWeaponType        weaponType = nil;
                
                if ([itemText isEqual:FORWARD_FACING_STRING]) weaponType = forward_weapon_type;
                if ([itemText isEqual:AFT_FACING_STRING]) weaponType = aft_weapon_type;
                if ([itemText isEqual:PORT_FACING_STRING]) weaponType = port_weapon_type;
                if ([itemText isEqual:STARBOARD_FACING_STRING]) weaponType = starboard_weapon_type;
                
                if (weaponType != nil)
                {
                    BOOL        sameAs = OOWeaponTypeFromEquipmentIdentifierSloppy([gui selectedRowKey]) == weaponType;
                    // override showInformation _completely_ with itemText
                    if ([[weaponType identifier] isEqualToString:@"EQ_WEAPON_NONE"])  itemText = DESC(@"no-weapon-enter-to-install");
                    else
                    {
                        NSString *weaponName = [[OOEquipmentType equipmentTypeWithIdentifier:OOEquipmentIdentifierFromWeaponType(weaponType)] name];
                        if (sameAs)  itemText = [NSString stringWithFormat:DESC(@"weapon-installed-@"), weaponName];
                        else  itemText = [NSString stringWithFormat:DESC(@"weapon-@-enter-to-replace"), weaponName];
                    }
                    
                    [self showInformationForSelectedUpgradeWithFormatString:itemText];
                }
                else
                    [self showInformationForSelectedUpgrade];
            }
            
            if ([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up])
            {
                if ((!leftRightKeyPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
                {
                    if ([[gui keyForRow:GUI_ROW_EQUIPMENT_START] hasPrefix:@"More:"])
                    {
                        [self playMenuPagePrevious];
                        [gui setSelectedRow:GUI_ROW_EQUIPMENT_START];
                        [self buySelectedItem];
                    }
                    timeLastKeyPress = script_time;
                }
            }
            if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down])
            {
                if ((!leftRightKeyPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
                {
                    if ([[gui keyForRow:GUI_ROW_EQUIPMENT_START + GUI_MAX_ROWS_EQUIPMENT - 1] hasPrefix:@"More:"])
                    {
                        [self playMenuPageNext];
                        [gui setSelectedRow:GUI_ROW_EQUIPMENT_START + GUI_MAX_ROWS_EQUIPMENT - 1];
                        [self buySelectedItem];
                    }
                    timeLastKeyPress = script_time;
                }
            }
            leftRightKeyPressed = [self checkKeyPress:n_key_gui_arrow_right]|[self checkKeyPress:n_key_gui_arrow_left]|[self checkKeyPress:n_key_gui_page_down]|[self checkKeyPress:n_key_gui_page_up];
 
            if ([self checkKeyPress:n_key_gui_select] || [gameView isDown:gvMouseDoubleClick])
            {
                if ([gameView isDown:gvMouseDoubleClick])
                {
                    selectPressed = NO;
                    [gameView clearMouse];
                }
                if ((!selectPressed)&&([gui selectedRow] > -1))
                {
                    [self buySelectedItem];
                    selectPressed = YES;
                }
            }
            else
            {
                selectPressed = NO;
            }
            break;
            
        case GUI_SCREEN_INTERFACES:
            if ([self handleGUIUpDownArrowKeys])
            {
                [self showInformationForSelectedInterface];
            }
            if ([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up])
            {
                if ((!leftRightKeyPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
                {
                    if ([[gui keyForRow:GUI_ROW_INTERFACES_START] hasPrefix:@"More:"])
                    {
                        [self playMenuPagePrevious];
                        [gui setSelectedRow:GUI_ROW_INTERFACES_START];
                        [self activateSelectedInterface];
                    }
                    timeLastKeyPress = script_time;
                }
            }
            if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down])
            {
                if ((!leftRightKeyPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
                {
                    if ([[gui keyForRow:GUI_ROW_INTERFACES_START + GUI_MAX_ROWS_INTERFACES - 1] hasPrefix:@"More:"])
                    {
                        [self playMenuPageNext];
                        [gui setSelectedRow:GUI_ROW_INTERFACES_START + GUI_MAX_ROWS_INTERFACES - 1];
                        [self activateSelectedInterface];
                    }
                    timeLastKeyPress = script_time;
                }
            }
            leftRightKeyPressed = [self checkKeyPress:n_key_gui_arrow_right]|[self checkKeyPress:n_key_gui_arrow_left]|[self checkKeyPress:n_key_gui_page_down]|[self checkKeyPress:n_key_gui_page_up];
            if ([self checkKeyPress:n_key_gui_select] || [gameView isDown:gvMouseDoubleClick])   // 'enter'
            {
                if ([gameView isDown:gvMouseDoubleClick])
                {
                    selectPressed = NO;
                    [gameView clearMouse];
                }
                if ((!selectPressed)&&([gui selectedRow] > -1))
                {
                    [self activateSelectedInterface];
                    selectPressed = YES;
                }
            }
            else
            {
                selectPressed = NO;
            }
            break;
 
 
        case GUI_SCREEN_MARKETINFO:
            [self pollMarketScreenControls];
            break;
 
        case GUI_SCREEN_MARKET:
            [self pollMarketScreenControls];
 
            if ([self checkKeyPress:n_key_market_filter_cycle] || [self checkKeyPress:n_key_market_sorter_cycle])
            {
                if (!queryPressed)
                {
                    queryPressed = YES;
                    if ([self checkKeyPress:n_key_market_filter_cycle])
                    {
                        if (marketFilterMode >= MARKET_FILTER_MODE_MAX)
                        {
                            marketFilterMode = MARKET_FILTER_MODE_OFF;
                        }
                        else
                        {
                            marketFilterMode++;
                        }
                    }
                    else
                    {
                        if (marketSorterMode >= MARKET_SORTER_MODE_MAX)
                        {
                            marketSorterMode = MARKET_SORTER_MODE_OFF;
                        }
                        else
                        {
                            marketSorterMode++;
                        }
                    }
                    [self playChangedOption];
                    [self setGuiToMarketScreen];
                }
            } 
            else
            {
                queryPressed = NO;
            }
 
            break;
            
        case GUI_SCREEN_REPORT:
            if ([gameView isDown:32])   // spacebar
            {
                if (!spacePressed)
                {
                    BOOL reportEnded = ([dockingReport length] == 0);
                    [self playDismissedReportScreen];
                    if(reportEnded)
                    {
                        [self setGuiToStatusScreen];
                        [self doScriptEvent:OOJSID("reportScreenEnded")];  // last report given. Screen is now free for missionscreens.
                        [self doWorldEventUntilMissionScreen:OOJSID("missionScreenOpportunity")];
                    }
                    else
                    {
                        [self setGuiToDockingReportScreen];
                    }
 
                }
                spacePressed = YES;
            }
            else
                spacePressed = NO;
            break;
        case GUI_SCREEN_STATUS:
            [self handleGUIUpDownArrowKeys];
            if ([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up])
            {
 
                if ((!leftRightKeyPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
                {
                    if ([[gui keyForRow:STATUS_EQUIPMENT_FIRST_ROW] isEqual:GUI_KEY_OK])
                    {
                        [gui setSelectedRow:STATUS_EQUIPMENT_FIRST_ROW];
                        [self playMenuPagePrevious];
                        [gui setStatusPage:-1];
                        [self setGuiToStatusScreen];
                    }
                    timeLastKeyPress = script_time;
                }
            }
            if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down])
            {
 
                if ((!leftRightKeyPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
                {
                    NSUInteger maxRows = [[self hud] allowBigGui] ? STATUS_EQUIPMENT_MAX_ROWS + STATUS_EQUIPMENT_BIGGUI_EXTRA_ROWS : STATUS_EQUIPMENT_MAX_ROWS;
                    if ([[gui keyForRow:STATUS_EQUIPMENT_FIRST_ROW + maxRows] isEqual:GUI_KEY_OK])
                    {
                        [gui setSelectedRow:STATUS_EQUIPMENT_FIRST_ROW + maxRows];
                        [self playMenuPageNext];
                        [gui setStatusPage:+1];
                        [self setGuiToStatusScreen];
                    }
                    timeLastKeyPress = script_time;
                }
            }
            leftRightKeyPressed = [self checkKeyPress:n_key_gui_arrow_right]|[self checkKeyPress:n_key_gui_arrow_left]|[self checkKeyPress:n_key_gui_page_down]|[self checkKeyPress:n_key_gui_page_up];
            
            if ([self checkKeyPress:n_key_gui_select] || [gameView isDown:gvMouseDoubleClick])
            {
                if ([gameView isDown:gvMouseDoubleClick])
                {
                    selectPressed = NO;
                    [gameView clearMouse];
                }
                if ((!selectPressed)&&([gui selectedRow] > -1))
                {
                    [gui setStatusPage:([gui selectedRow] == STATUS_EQUIPMENT_FIRST_ROW ? -1 : +1)];
                    [self setGuiToStatusScreen];
 
                    selectPressed = YES;
                }
            }
            else
            {
                selectPressed = NO;
            }
 
            break;
        case GUI_SCREEN_MANIFEST:
            [self handleGUIUpDownArrowKeys];
            if ([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up])
            {
 
                if ((!leftRightKeyPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
                {
                    if ([[gui keyForRow:MANIFEST_SCREEN_ROW_BACK] isEqual:GUI_KEY_OK])
                    {
                        [gui setSelectedRow:MANIFEST_SCREEN_ROW_BACK];
                        [self playMenuPagePrevious];
                        [gui setStatusPage:-1];
                        [self setGuiToManifestScreen];
                    }
                    timeLastKeyPress = script_time;
                }
            }
            if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down])
            {
                OOGUIRow nextRow = MANIFEST_SCREEN_ROW_NEXT;
                if ([[self hud] isHidden] || [[self hud] allowBigGui])
                {
                    nextRow += 7;
                }
                if ((!leftRightKeyPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
                {
                    if ([[gui keyForRow:nextRow] isEqual:GUI_KEY_OK])
                    {
                        [gui setSelectedRow:nextRow];
                        [self playMenuPageNext];
                        [gui setStatusPage:+1];
                        [self setGuiToManifestScreen];
                    }
                    timeLastKeyPress = script_time;
                }
            }
            leftRightKeyPressed = [self checkKeyPress:n_key_gui_arrow_right]|[self checkKeyPress:n_key_gui_arrow_left]|[self checkKeyPress:n_key_gui_page_down]|[self checkKeyPress:n_key_gui_page_up];
            
            if ([self checkKeyPress:n_key_gui_select] || [gameView isDown:gvMouseDoubleClick])
            {
                if ([gameView isDown:gvMouseDoubleClick])
                {
                    selectPressed = NO;
                    [gameView clearMouse];
                }
                if ((!selectPressed)&&([gui selectedRow] > -1))
                {
                    [gui setStatusPage:([gui selectedRow] == MANIFEST_SCREEN_ROW_BACK ? -1 : +1)];
                    [self setGuiToManifestScreen];
 
                    selectPressed = YES;
                }
            }
            else
            {
                selectPressed = NO;
            }
 
            break;
 
        case GUI_SCREEN_SHIPYARD:
            if ([self handleGUIUpDownArrowKeys])
            {
                [self showShipyardInfoForSelection];
            }
            
            if ([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up])
            {
                if ((!leftRightKeyPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
                {
                    if ([[gui keyForRow:GUI_ROW_SHIPYARD_START] hasPrefix:@"More:"])
                    {
                        [self playMenuPagePrevious];
                        [gui setSelectedRow:GUI_ROW_SHIPYARD_START];
                        [self buySelectedShip];
                    }
                    timeLastKeyPress = script_time;
                }
            }
            if ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down])
            {
                if ((!leftRightKeyPressed)||(script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
                {
                    if ([[gui keyForRow:GUI_ROW_SHIPYARD_START + MAX_ROWS_SHIPS_FOR_SALE - 1] hasPrefix:@"More:"])
                    {
                        [self playMenuPageNext];
                        [gui setSelectedRow:GUI_ROW_SHIPYARD_START + MAX_ROWS_SHIPS_FOR_SALE - 1];
                        [self buySelectedShip];
                    }
                    timeLastKeyPress = script_time;
                }
            }
            leftRightKeyPressed = [self checkKeyPress:n_key_gui_arrow_right]|[self checkKeyPress:n_key_gui_arrow_left]|[self checkKeyPress:n_key_gui_page_down]|[self checkKeyPress:n_key_gui_page_up];
            
            if ([self checkKeyPress:n_key_gui_select]) // 'enter' NOT double-click
            {
                if (!selectPressed)
                {
                    // try to buy the ship!
                    NSString *key = [gui keyForRow:[gui selectedRow]];
                    OOCreditsQuantity shipprice = 0;
                    if (![key hasPrefix:@"More:"])
                    {
                        shipprice = [self priceForShipKey:key];
                    }
 
                    if ([self buySelectedShip])
                    {
                        if (![key hasPrefix:@"More:"]) // don't do anything if we clicked/selected a "More:" line
                        {
                            [UNIVERSE removeDemoShips];
                            [self setGuiToStatusScreen];
                            [self playBuyShip];
                            [self doScriptEvent:OOJSID("playerBoughtNewShip") withArgument:self andArgument:[NSNumber numberWithUnsignedLongLong:shipprice]]; // some equipment.oxp might want to know everything has changed.
                        }
                    }
                    else
                    {
                        [self playCantBuyShip];
                    }
                }
                selectPressed = YES;
            }
            else
            {
                selectPressed = NO;
            }
            if ([gameView isDown:gvMouseDoubleClick])
            {
                if (([gui selectedRow] == GUI_ROW_SHIPYARD_START + MAX_ROWS_SHIPS_FOR_SALE - 1) && [[gui keyForRow:GUI_ROW_SHIPYARD_START + MAX_ROWS_SHIPS_FOR_SALE - 1] hasPrefix:@"More:"])
                {
                    [self playMenuPageNext];
                    [gui setSelectedRow:GUI_ROW_SHIPYARD_START + MAX_ROWS_SHIPS_FOR_SALE - 1];
                    [self buySelectedShip];
                }
                else if (([gui selectedRow] == GUI_ROW_SHIPYARD_START) && [[gui keyForRow:GUI_ROW_SHIPYARD_START] hasPrefix:@"More:"])
                {
                    [self playMenuPagePrevious];
                    [gui setSelectedRow:GUI_ROW_SHIPYARD_START];
                    [self buySelectedShip];
                }
                [gameView clearMouse];
            }
 
            break;
            
        default:
            break;
    }
 
    // check for any extra keys added by scripting
    NSArray *keys = [extraGuiScreenKeys objectForKey:[NSString stringWithFormat:@"%d", gui_screen]];
    if (keys) {
        NSInteger kc = [keys count];
        OOJSGuiScreenKeyDefinition *definition = nil;
        NSDictionary *keydefs = nil;
        NSString *key = nil;
        while (kc--) {
            definition = [keys objectAtIndex:kc];
            keydefs = [definition registerKeys];
            foreach (key, [keydefs allKeys])
            {
                if ([self checkKeyPress:[keydefs objectForKey:key]]) 
                {
                    if (!extra_gui_key_pressed) 
                    {
                        // do callback
                        if (definition)
                        {
                            [[UNIVERSE gameView] clearKeys];
                            [definition runCallback:key];
                        }
                        else
                        {
                            OOLog(@"interface.missingCallback", @"Unable to find callback definition for %@ using key %@", [definition name], key);
                        }
                    }
                    extra_gui_key_pressed = YES;
                }
                else
                    extra_gui_key_pressed = NO;
            }
        }
    }
 
    // damp any rotations we entered with
    if (flightRoll > 0.0)
    {
        if (flightRoll > delta_t)       [self decrease_flight_roll:delta_t];
        else    flightRoll = 0.0;
    }
    if (flightRoll < 0.0)
    {
        if (flightRoll < -delta_t)      [self increase_flight_roll:delta_t];
        else    flightRoll = 0.0;
    }
    if (flightPitch > 0.0)
    {
        if (flightPitch > delta_t)      [self decrease_flight_pitch:delta_t];
        else    flightPitch = 0.0;
    }
    if (flightPitch < 0.0)
    {
        if (flightPitch < -delta_t)     [self increase_flight_pitch:delta_t];
        else    flightPitch = 0.0;
    }
    if (flightYaw > 0.0) 
    { 
        if (flightYaw > delta_t)        [self decrease_flight_yaw:delta_t]; 
        else    flightYaw = 0.0; 
    } 
    if (flightYaw < 0.0) 
    { 
        if (flightYaw < -delta_t)       [self increase_flight_yaw:delta_t]; 
        else    flightYaw = 0.0; 
    } 
}

Referenced by PlayerEntity(OOControlsPrivate)::handleAutopilotOn:.

Here is the caller graph for this function:

pollGuiScreenControls

- (void) pollGuiScreenControls

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

{
    [self pollGuiScreenControlsWithFKeyAlias:YES];
}

Referenced by PlayerEntity(OOControlsPrivate)::handleAutopilotOn:.

Here is the caller graph for this function:

pollGuiScreenControlsWithFKeyAlias:

- (void) pollGuiScreenControlsWithFKeyAlias: (BOOL)  fKeyAlias

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

                                           :(BOOL)fKeyAlias
{
    if(!pollControls && fKeyAlias)  // Still OK to run, if we don't use number keys.
        return;
    
    GuiDisplayGen   *gui = [UNIVERSE gui];
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    BOOL            docked_okay = ([self status] == STATUS_DOCKED);
    
    //  text displays
    if ([self checkKeyPress:n_key_gui_screen_status fKey_only:!fKeyAlias])
    {
        if (!switching_status_screens)
        {
            switching_status_screens = YES;
            if (gui_screen == GUI_SCREEN_STATUS)
            {
                [self noteGUIWillChangeTo:GUI_SCREEN_MANIFEST];
                [self setGuiToManifestScreen];
            }
            else
                [self setGuiToStatusScreen];
            [self checkScript];
        }
    }
    else
    {
        switching_status_screens = NO;
    }
    
    if ([self checkKeyPress:n_key_gui_chart_screens fKey_only:!fKeyAlias])
    {
        mouse_left_down = NO;
        [gameView clearMouse];
        if  (!switching_chart_screens)
        {
            switching_chart_screens = YES;
            // handles http://aegidian.org/bb/viewtopic.php?p=233189#p233189
            if (EXPECT_NOT([self status] == STATUS_WITCHSPACE_COUNTDOWN && gui_screen == GUI_SCREEN_SHORT_RANGE_CHART)) 
            {
                // don't switch to LRC if countdown in progress
                switching_chart_screens = NO;
            }
            else if (gui_screen == GUI_SCREEN_SHORT_RANGE_CHART || (gui_screen == GUI_SCREEN_SYSTEM_DATA && showingLongRangeChart))
            {
                if (target_chart_zoom != CHART_MAX_ZOOM)
                {
                    saved_chart_zoom = target_chart_zoom;
                }
                target_chart_zoom = CHART_MAX_ZOOM;
                [self noteGUIWillChangeTo:GUI_SCREEN_LONG_RANGE_CHART];
                [self setGuiToLongRangeChartScreen];
            }
            else
            {
                if (target_chart_zoom == CHART_MAX_ZOOM)
                {
                    target_chart_zoom = saved_chart_zoom;
                }
                //target_chart_centre = cursor_coordinates = [[UNIVERSE systemManager] getCoordinatesForSystem:target_system_id inGalaxy:galaxy_number];
                [self noteGUIWillChangeTo:GUI_SCREEN_SHORT_RANGE_CHART];
                [self setGuiToShortRangeChartScreen];
            }
        }
    }
    else
    {
        switching_chart_screens = NO;
    }
    
    if ([self checkKeyPress:n_key_gui_system_data fKey_only:!fKeyAlias])
    {
        if (gui_screen != GUI_SCREEN_SYSTEM_DATA)
        {
            showingLongRangeChart = (gui_screen == GUI_SCREEN_LONG_RANGE_CHART);
            [self noteGUIWillChangeTo:GUI_SCREEN_SYSTEM_DATA];
            [self setGuiToSystemDataScreen];
        }
    }
 
    if ([self checkKeyPress:n_key_gui_market fKey_only:!fKeyAlias])
    {
        if (gui_screen != GUI_SCREEN_MARKET)
        {
            [gameView clearKeys];
            [gui setNoSelectedRow];
            [self noteGUIWillChangeTo:GUI_SCREEN_MARKET];
            [self setGuiToMarketScreen];
        }
        else
        {
            [gameView clearKeys];
            [gui setNoSelectedRow];
            [self noteGUIWillChangeTo:GUI_SCREEN_MARKETINFO];
            [self setGuiToMarketInfoScreen];
        }
    }
    
    
    if (docked_okay)
    {   
        if (([self checkKeyPress:n_key_gui_screen_options fKey_only:!fKeyAlias]) && (gui_screen != GUI_SCREEN_OPTIONS))
        {
            [gameView clearKeys];
            [self setGuiToLoadSaveScreen];
        }
        
        if ([self checkKeyPress:n_key_gui_screen_equipship fKey_only:!fKeyAlias])
        {
            if (!switching_equipship_screens)
            {
                if ([self dockedStation] == nil)  [self setDockedAtMainStation];
                OOGUIScreenID oldScreen = gui_screen;
                
                if ((gui_screen == GUI_SCREEN_EQUIP_SHIP) && [[self dockedStation] hasShipyard])
                {
                    [gameView clearKeys];
                    [self noteGUIWillChangeTo:GUI_SCREEN_SHIPYARD];
                    [gui setNoSelectedRow];
                    [self setGuiToShipyardScreen:0];
                    [gui setSelectedRow:GUI_ROW_SHIPYARD_START];
                    [self showShipyardInfoForSelection];
                }
                else
                {
                    [gameView clearKeys];
                    [self noteGUIWillChangeTo:GUI_SCREEN_EQUIP_SHIP];
                    [gui setNoSelectedRow];
                    [self setGuiToEquipShipScreen:0];
                    [gui setSelectedRow:GUI_ROW_EQUIPMENT_START];
                }
                
                [self noteGUIDidChangeFrom:oldScreen to:gui_screen]; 
            }
            switching_equipship_screens = YES;
        }
        else
        {
            switching_equipship_screens = NO;
        }
        
        if ([self checkKeyPress:n_key_gui_screen_interfaces fKey_only:!fKeyAlias])
        {
            if (!switching_interface_screens) {
                [gui setNoSelectedRow];
                [self setGuiToInterfacesScreen:0];
                [gui setSelectedRow:GUI_ROW_INTERFACES_START];
            }
            switching_interface_screens = YES;
        }
        else 
        {
            switching_interface_screens = NO;
        }
 
    }
}

pollMarketScreenControls

- (void) pollMarketScreenControls

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
 
    if (gui_screen == GUI_SCREEN_MARKET)
    {
        [self handleGUIUpDownArrowKeys];
        DESTROY(marketSelectedCommodity);
        marketSelectedCommodity = [[gui selectedRowKey] retain];
 
        BOOL            page_up = [self checkKeyPress:n_key_gui_page_up]; 
        BOOL            page_down = [self checkKeyPress:n_key_gui_page_down]; 
        if (page_up || page_down) 
        {
            if ((!pageUpDownKeyPressed) || (script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
            {
                OOCommodityMarket   *localMarket = [self localMarket];
                NSArray             *goods = [self applyMarketSorter:[self applyMarketFilter:[localMarket goods] onMarket:localMarket] onMarket:localMarket];
                if ([goods count] > 0)
                {
                    NSInteger goodsIndex = [goods indexOfObject:marketSelectedCommodity];
                    NSInteger offset1 = 0;
                    NSInteger offset2 = 0;
                    if ([[gui keyForRow:GUI_ROW_MARKET_START] isEqualToString:@"<<<"] == true) offset1 += 1;
                    if ([[gui keyForRow:GUI_ROW_MARKET_LAST] isEqualToString:@">>>"] == true) offset2 += 1;
                    if (page_up)
                    {
                        [self playMenuPagePrevious];
                        // some edge cases
                        if (goodsIndex - 16 <= 0) 
                        {
                            offset1 = 0;
                            offset2 = 0;
                        }
                        if (offset1 == 1 && offset2 == 0 && goodsIndex < (NSInteger)[goods count] - 1 && goodsIndex - 15 > 0) offset2 = 1;
                        goodsIndex -= (16 - (offset1 + offset2));
                        if (goodsIndex < 0) goodsIndex = 0;
                        if ([goods count] <= 17) goodsIndex = 0;
                    }
                    if (page_down) 
                    {
                        [self playMenuPageNext];
                        // some edge cases
                        if (offset1 == 0 && offset2 == 1 && goodsIndex > 1) offset1 = 1;
                        if (offset2 == 1 && goodsIndex + 15 == (NSInteger)[goods count] - 1) offset2 = 0;
                        goodsIndex += (16 - (offset1 + offset2));
                        if (goodsIndex > ((NSInteger)[goods count] - 1) || [goods count] <= 17) goodsIndex = (NSInteger)[goods count] - 1;
                    }
                    DESTROY(marketSelectedCommodity);
                    marketSelectedCommodity = [[goods oo_stringAtIndex:goodsIndex] retain];
                    [self setGuiToMarketScreen];
                }
            } 
            pageUpDownKeyPressed = YES;
            timeLastKeyPress = script_time;
        }
        else {
            pageUpDownKeyPressed = NO;
        }
    }
    else
    {
        // handle up and down slightly differently
        BOOL            arrow_up = [self checkKeyPress:n_key_gui_arrow_up]; 
        BOOL            arrow_down = [self checkKeyPress:n_key_gui_arrow_down]; 
        if (arrow_up || arrow_down)
        {
            if ((!upDownKeyPressed) || (script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
            {
                OOCommodityMarket   *localMarket = [self localMarket];
                NSArray             *goods = [self applyMarketSorter:[self applyMarketFilter:[localMarket goods] onMarket:localMarket] onMarket:localMarket];
                if ([goods count] > 0)
                {
                    NSInteger goodsIndex = [goods indexOfObject:marketSelectedCommodity];
                    if (arrow_down)
                    {
                        ++goodsIndex;
                    }
                    else
                    {
                        --goodsIndex;
                    }
                    if (goodsIndex < 0)
                    {
                        goodsIndex = [goods count]-1;
                    }
                    else if (goodsIndex >= (NSInteger)[goods count])
                    {
                        goodsIndex = 0;
                    }
                    DESTROY(marketSelectedCommodity);
                    marketSelectedCommodity = [[goods oo_stringAtIndex:goodsIndex] retain];
                    [self setGuiToMarketInfoScreen];
                }
            }
            upDownKeyPressed = YES;
            timeLastKeyPress = script_time;
        }
        else
        {
            upDownKeyPressed = NO;
        }
    }
 
    BOOL isdocked = [self isDocked];
 
    if (([self checkNavKeyPress:n_key_gui_arrow_right])||([self checkNavKeyPress:n_key_gui_arrow_left])||([self checkKeyPress:n_key_gui_select]||[gameView isDown:gvMouseDoubleClick]))
    {
        if ([self checkNavKeyPress:n_key_gui_arrow_right])   // -->
        {
            if (!wait_for_key_up)
            {
                if (isdocked && [self tryBuyingCommodity:marketSelectedCommodity all:[gameView isShiftDown]])
                {
                    [self playBuyCommodity];
                    if (gui_screen == GUI_SCREEN_MARKET)
                    {
                        [self setGuiToMarketScreen];
                    }
                    else
                    {
                        [self setGuiToMarketInfoScreen];
                    }
                }
                else
                {
                    if ([[gui selectedRowKey] isEqualToString:@">>>"])
                    {
                        [self playMenuNavigationDown];
                        [self setGuiToMarketScreen];
                    }
                    else if ([[gui selectedRowKey] isEqualToString:@"<<<"])
                    {
                        [self playMenuNavigationUp];
                        [self setGuiToMarketScreen];
                    }
                    else
                    {
                        [self playCantBuyCommodity];
                    }
                }
                wait_for_key_up = YES;
            }
        }
        if ([self checkNavKeyPress:n_key_gui_arrow_left])   // <--
        {
            if (!wait_for_key_up)
            {
                if (isdocked && [self trySellingCommodity:marketSelectedCommodity all:[gameView isShiftDown]])
                {
                    [self playSellCommodity];
                    if (gui_screen == GUI_SCREEN_MARKET)
                    {
                        [self setGuiToMarketScreen];
                    }
                    else
                    {
                        [self setGuiToMarketInfoScreen];
                    }
                }
                else
                {
                    if ([[gui selectedRowKey] isEqualToString:@">>>"])
                    {
                        [self playMenuNavigationDown];
                        [self setGuiToMarketScreen];
                    }
                    else if ([[gui selectedRowKey] isEqualToString:@"<<<"])
                    {
                        [self playMenuNavigationUp];
                        [self setGuiToMarketScreen];
                    }
                    else
                    {
                        [self playCantSellCommodity];
                    }
 
                }
                wait_for_key_up = YES;
            }
        }
        if ((gui_screen == GUI_SCREEN_MARKET && [gameView isDown:gvMouseDoubleClick]) || [self checkKeyPress:n_key_gui_select])   // 'enter'
        {
            if ([gameView isDown:gvMouseDoubleClick])
            {
                wait_for_key_up = NO;
                [gameView clearMouse];
            }
            if (!wait_for_key_up)
            {
                OOCommodityType item = marketSelectedCommodity;
                OOCargoQuantity yours = [shipCommodityData quantityForGood:item];
                if ([item isEqualToString:@">>>"])
                {
                    [self tryBuyingCommodity:item all:YES];
                    [self setGuiToMarketScreen];
                }
                else if ([item isEqualToString:@"<<<"])
                {
                    [self trySellingCommodity:item all:YES];
                    [self setGuiToMarketScreen];
                }
                else if (isdocked && [gameView isShiftDown] && [self tryBuyingCommodity:item all:YES])  // buy as much as possible (with Shift)
                {
                    [self playBuyCommodity];
                    if (gui_screen == GUI_SCREEN_MARKET)
                    {
                        [self setGuiToMarketScreen];
                    }
                    else
                    {
                        [self setGuiToMarketInfoScreen];
                    }
                }
                else if (isdocked && (yours > 0) && [self trySellingCommodity:item all:YES])    // sell all you can
                {
                    [self playSellCommodity];
                    if (gui_screen == GUI_SCREEN_MARKET)
                    {
                        [self setGuiToMarketScreen];
                    }
                    else
                    {
                        [self setGuiToMarketInfoScreen];
                    }
                }
                else if (isdocked && [self tryBuyingCommodity:item all:YES])            // buy as much as possible
                {
                    [self playBuyCommodity];
                    if (gui_screen == GUI_SCREEN_MARKET)
                    {
                        [self setGuiToMarketScreen];
                    }
                    else
                    {
                        [self setGuiToMarketInfoScreen];
                    }
                }
                else if (isdocked)
                {
                    [self playCantBuyCommodity];
                }
                wait_for_key_up = YES;
            }
        }
    }
    else
    {
        wait_for_key_up = NO;
    }
 
 
 
 
}

pollMissionInterruptControls

- (void) pollMissionInterruptControls

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

{
    if (_missionAllowInterrupt)
    {
        if (gui_screen == GUI_SCREEN_MISSION && _missionTextEntry) 
        {
            [self pollGuiScreenControlsWithFKeyAlias:NO];
        }
        else {
            [self pollGuiScreenControls];
        }
        if (gui_screen != GUI_SCREEN_MISSION)
        {
            if (gui_screen != GUI_SCREEN_SYSTEM_DATA)
            {
                [UNIVERSE removeDemoShips];
            }
            [self endMissionScreenAndNoteOpportunity];
        }
    }
}

pollViewControls

- (void) pollViewControls

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 164 of file PlayerEntityControls.m.

{
    if(!pollControls)
        return;
    
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    OOJoystickManager *stickHandler = [OOJoystickManager sharedStickHandler];
    
    NSPoint         virtualView = NSZeroPoint;
    double          view_threshold = 0.5;
    
    if ([stickHandler joystickCount])
    {
        virtualView = [stickHandler viewAxis];
        if (virtualView.y == STICK_AXISUNASSIGNED)
            virtualView.y = 0.0;
        if (virtualView.x == STICK_AXISUNASSIGNED)
            virtualView.x = 0.0;
        if (fabs(virtualView.y) >= fabs(virtualView.x))
            virtualView.x = 0.0; // forward/aft takes precedence
        else
            virtualView.y = 0.0;
    }
    
    const BOOL *joyButtonState = [stickHandler getAllButtonStates];
    
    //  view keys
    if (([self checkKeyPress:n_key_view_forward]) || (virtualView.y < -view_threshold)||joyButtonState[BUTTON_VIEWFORWARD] || ((([self checkKeyPress:n_key_hyperspace] && gui_screen != GUI_SCREEN_LONG_RANGE_CHART) || joyButtonState[BUTTON_HYPERDRIVE]) && [UNIVERSE displayGUI]))
    {
        [self switchToThisView:VIEW_FORWARD];
    }
    if (([self checkKeyPress:n_key_view_aft])||(virtualView.y > view_threshold)||joyButtonState[BUTTON_VIEWAFT])
    {
        [self switchToThisView:VIEW_AFT];
    }
    if (([self checkKeyPress:n_key_view_port])||(virtualView.x < -view_threshold)||joyButtonState[BUTTON_VIEWPORT])
    {
        [self switchToThisView:VIEW_PORT];
    }
    if (([self checkKeyPress:n_key_view_starboard])||(virtualView.x > view_threshold)||joyButtonState[BUTTON_VIEWSTARBOARD])
    {
        [self switchToThisView:VIEW_STARBOARD];
    }
    
    [self pollCustomViewControls];
    
    // Zoom scanner 'z'
    if (([self checkKeyPress:n_key_scanner_zoom] && ([gameView allowingStringInput] == gvStringInputNo)) || joyButtonState[BUTTON_SCANNERZOOM]) // look for the 'z' key
    {
        if (!scanner_zoom_rate)
        {
            if ([hud scannerZoom] < 5.0)
            {
                if (([hud scannerZoom] > 1.0)||(!zoom_pressed))
                    scanner_zoom_rate = SCANNER_ZOOM_RATE_UP;
            }
            else
            {
                if (!zoom_pressed)  // must release and re-press zoom to zoom back down..
                    scanner_zoom_rate = SCANNER_ZOOM_RATE_DOWN;
            }
        }
        zoom_pressed = YES;
    }
    else
        zoom_pressed = NO;
    
    // Unzoom scanner 'Z'
    if (([self checkKeyPress:n_key_scanner_unzoom] && ([gameView allowingStringInput] == gvStringInputNo)) || joyButtonState[BUTTON_SCANNERUNZOOM]) // look for the 'Z' key
    {
        if ((!scanner_zoom_rate)&&([hud scannerZoom] > 1.0))
            scanner_zoom_rate = SCANNER_ZOOM_RATE_DOWN;
    }
    
    if (EXPECT([[self hud] isCompassActive]))   // only switch compass modes if there is a compass
    {
        // Compass mode '|'
        if ([self checkKeyPress:n_key_prev_compass_mode] || joyButtonState[BUTTON_COMPASSMODE_PREV]) // look for the '|' key
        {
            if ((!prev_compass_mode_pressed)&&(compassMode != COMPASS_MODE_BASIC))
                [self setPrevCompassMode];
            prev_compass_mode_pressed = YES;
        }
        else
        {
            prev_compass_mode_pressed = NO;
        }
        // Compass mode '\'
        if ([self checkKeyPress:n_key_next_compass_mode] || joyButtonState[BUTTON_COMPASSMODE]) // look for the '\' key
        {
            if ((!next_compass_mode_pressed)&&(compassMode != COMPASS_MODE_BASIC))
                [self setNextCompassMode];
            next_compass_mode_pressed = YES;
        }
        else
        {
            next_compass_mode_pressed = NO;
        }
    }
    
    // ';' // Cycle active MFD
    if ([self checkKeyPress:n_key_cycle_next_mfd] || [self checkKeyPress:n_key_cycle_previous_mfd] || joyButtonState[BUTTON_MFDCYCLENEXT] || joyButtonState[BUTTON_MFDCYCLEPREV])
    {
        if (!cycleMFD_pressed)
        {
            //if (![gameView isCtrlDown]) 
            if (![self checkKeyPress:n_key_cycle_previous_mfd] || joyButtonState[BUTTON_MFDCYCLEPREV]) 
            {
                [self cycleNextMultiFunctionDisplay:activeMFD];
            }
            else
            {
                [self cyclePreviousMultiFunctionDisplay:activeMFD];
            }
        }
        cycleMFD_pressed = YES;
    }
    else
    {
        cycleMFD_pressed = NO;
    }
 
    //  ':' // Select next MFD
    if ([self checkKeyPress:n_key_switch_next_mfd] || [self checkKeyPress:n_key_switch_previous_mfd] || joyButtonState[BUTTON_MFDSELECTNEXT] || joyButtonState[BUTTON_MFDSELECTPREV])
    {
        if ([[self hud] mfdCount] > 1)
        {
            if (!switchMFD_pressed)
            {
                //if (![gameView isCtrlDown])
                if (![self checkKeyPress:n_key_switch_previous_mfd] || joyButtonState[BUTTON_MFDSELECTPREV])
                {
                    [self selectNextMultiFunctionDisplay];
                }
                else
                {
                    [self selectPreviousMultiFunctionDisplay];
                }
            }
        }
        switchMFD_pressed = YES;
    }
    else
    {
        switchMFD_pressed = NO;
    }
                
 
    //  show comms log '`'
    if ([self checkKeyPress:n_key_comms_log])
    {
        [UNIVERSE showCommsLog: 1.5];
        [hud refreshLastTransmitter];
    }
}

Referenced by PlayerEntity(OOControlsPrivate)::handleAutopilotOn:.

Here is the caller graph for this function:

prepareMarkedDestination:markers:

- (void) prepareMarkedDestination: (NSMutableDictionary *)  markers: (NSDictionary *)  marker

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                                 :(NSMutableDictionary *)markers :(NSDictionary *)marker
{
    NSNumber *key = [NSNumber numberWithInt:[marker oo_intForKey:@"system"]];
    NSMutableArray *list = [markers objectForKey:key];
    if (list == nil)
    {
        list = [NSMutableArray arrayWithObject:marker];
    }
    else
    {
        [list addObject:marker];
    }
    [markers setObject:list forKey:key];
}

previousInfoSystem

- (void) previousInfoSystem

Definition at line 13727 of file PlayerEntity.m.

{
    if (ANA_mode == OPTIMIZED_BY_NONE)
    {
        [self setInfoSystemID: system_id moveChart: YES];
        return;
    }
    NSArray *route = [[[UNIVERSE routeFromSystem:system_id toSystem:target_system_id optimizedBy:ANA_mode] oo_arrayForKey: @"route"] retain];
    NSUInteger i;
    if (route == nil)
    {
        [self setInfoSystemID: system_id moveChart: YES];
        return;
    }
    for (i = 0; i < [route count]; i++)
    {
        if ([[route objectAtIndex: i] intValue] == info_system_id)
        {
            if (i > 0)
            {
                [self setInfoSystemID: [[route objectAtIndex: i - 1] unsignedIntValue] moveChart: YES];
                [route release];
                return;
            }
            break;
        }
    }
    [route release];
    [self setInfoSystemID: system_id moveChart: YES];
    return;
}

previousSystemID

- (OOSystemID) previousSystemID

Definition at line 13727 of file PlayerEntity.m.

{
    return previous_system_id;
}

priceForShipKey:

- (OOCreditsQuantity) priceForShipKey:

(NSString *)

key

Provided by category PlayerEntity(Contracts).

Definition at line 1443 of file PlayerEntityContracts.m.

                                     :(NSString *)key
{
    NSDictionary *shipInfo = [currentShipyard oo_dictionaryForKey:key];
    return [shipInfo oo_unsignedLongLongForKey:SHIPYARD_KEY_PRICE];
}

primedEquipmentCount

- (NSUInteger) primedEquipmentCount

Definition at line 13727 of file PlayerEntity.m.

{
    return [eqScripts count];
}

primedEquipmentName:

- (NSString *) primedEquipmentName:

(NSInteger)

offset

Definition at line 13727 of file PlayerEntity.m.

                                  :(NSInteger)offset
{
    NSUInteger c = [self primedEquipmentCount];
    NSUInteger idx = (primedEquipment+(c+1)+offset)%(c+1);
    if (idx == c)
    {
        return DESC(@"equipment-primed-none-hud-label");
    }
    else
    {
        return [[OOEquipmentType equipmentTypeWithIdentifier:[[eqScripts oo_arrayAtIndex:idx] oo_stringAtIndex:0]] name];
    }
}

printIdentLockedOnForMissile:

- (void) printIdentLockedOnForMissile:

(BOOL)

missile

Definition at line 9242 of file PlayerEntity.m.

                                     :(BOOL)missile
{
    if ([self primaryTarget] == nil) return;
    
    NSString *fmt = missile ? @"missile-locked-onto-target" : @"ident-locked-onto-target";
    NSString *target = [[self primaryTarget] identFromShip:self];
    [UNIVERSE addMessage:OOExpandKey(fmt, target) forCount:4.5];
}

processEscapePods

- (NSString *) processEscapePods

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    unsigned        i;
    BOOL added_entry = NO; // to prevent empty lines for slaves and the rare empty report.
    NSMutableString *result = [NSMutableString string];
    NSMutableArray  *rescuees = [NSMutableArray array];
    OOGovernmentID  government = [[[UNIVERSE currentSystemData] objectForKey:KEY_GOVERNMENT] intValue];
    if ([UNIVERSE inInterstellarSpace])  government = 1;    // equivalent to Feudal. I'm assuming any station in interstellar space is military. -- Ahruman 2008-05-29
    
    // step through the cargo removing crew from any escape pods
    // No enumerator because we're mutating the array -- Ahruman
    for (i = 0; i < [cargo count]; i++)
    {
        ShipEntity  *cargoItem = [cargo objectAtIndex:i];
        NSArray     *podCrew = [cargoItem crew];
        
        if (podCrew != nil)
        {
            // Has crew -> is escape pod.
            [rescuees addObjectsFromArray:podCrew];
            [cargoItem setCrew:nil];
            [cargo removeObjectAtIndex:i];
            i--;
        }
    }
    
    // step through the rescuees awarding insurance or bounty or adding to slaves
    for (i = 0; i < [rescuees count]; i++)
    {
        OOCharacter *rescuee = [rescuees objectAtIndex:i];
        
        if ([rescuee script])
        {
            [rescuee doScriptEvent:OOJSID("unloadCharacter")];
        }
        else if ([rescuee legacyScript])
        {
            [self runUnsanitizedScriptActions:[rescuee legacyScript]
                            allowingAIMethods:YES
                              withContextName:[NSString stringWithFormat:@"<character \"%@\" script>", [rescuee name]]
                                    forTarget:nil];
        }
        else if ([rescuee insuranceCredits] && [rescuee legalStatus])
        {
            float reward = (5.0 + government) * [rescuee legalStatus];
            float insurance = 10 * [rescuee insuranceCredits];
            if (government > (Ranrot() & 7) || reward >= insurance)
            {
                // claim bounty for capture, ignore insurance
                [result appendFormat:DESC(@"capture-reward-for-@@-@-credits-@-alt"),
                 [rescuee name], [rescuee shortDescription], OOStringFromDeciCredits(reward, YES, NO),
                 OOStringFromDeciCredits(insurance, YES, NO)];
                [self doScriptEvent:OOJSID("playerRescuedEscapePod") withArguments:[NSArray arrayWithObjects:[NSNumber numberWithUnsignedInteger:reward],@"bounty",[rescuee infoForScripting],nil]];
            }
            else
            {
                // claim insurance reward with reduction of bounty
                [result appendFormat:DESC(@"rescue-reward-for-@@-@-credits-@-alt"),
                 [rescuee name], [rescuee shortDescription], OOStringFromDeciCredits(insurance - reward, YES, NO),
                 OOStringFromDeciCredits(reward, YES, NO)];
                reward = insurance - reward;
                [self doScriptEvent:OOJSID("playerRescuedEscapePod") withArguments:[NSArray arrayWithObjects:[NSNumber numberWithUnsignedInteger:reward],@"insurance",[rescuee infoForScripting],nil]];
            }
            credits += reward;
            added_entry = YES;
        }
        else if ([rescuee insuranceCredits])
        {
            // claim insurance reward
            [result appendFormat:DESC(@"rescue-reward-for-@@-@-credits"),
                [rescuee name], [rescuee shortDescription], OOStringFromDeciCredits([rescuee insuranceCredits] * 10, YES, NO)];
            credits += 10 * [rescuee insuranceCredits];
            [self doScriptEvent:OOJSID("playerRescuedEscapePod") withArguments:[NSArray arrayWithObjects:[NSNumber numberWithUnsignedInteger:(10 * [rescuee insuranceCredits])],@"insurance",[rescuee infoForScripting],nil]];
                
            added_entry = YES;
        }
        else if ([rescuee legalStatus])
        {
            // claim bounty for capture
            float reward = (5.0 + government) * [rescuee legalStatus];
            [result appendFormat:DESC(@"capture-reward-for-@@-@-credits"),
                [rescuee name], [rescuee shortDescription], OOStringFromDeciCredits(reward, YES, NO)];
            credits += reward;
            [self doScriptEvent:OOJSID("playerRescuedEscapePod") withArguments:[NSArray arrayWithObjects:[NSNumber numberWithUnsignedInteger:reward],@"bounty",[rescuee infoForScripting],nil]];
            added_entry = YES;
        }
        else
        {
            // sell as slave - increase no. of slaves in manifest
            [shipCommodityData addQuantity:1 forGood:@"slaves"];
            [self doScriptEvent:OOJSID("playerRescuedEscapePod") withArguments:[NSArray arrayWithObjects:[NSNumber numberWithUnsignedInteger:0],@"slave",[rescuee infoForScripting],nil]];
 
        }
        if ((i < [rescuees count] - 1) && added_entry)
            [result appendString:@"\n"];
        added_entry = NO;
    }
    
    [self calculateCurrentCargo];
    
    return result;
}

processKeyCode:

- (NSArray *) processKeyCode:

(NSArray*)

key_def

Provided by category PlayerEntity(Controls).

Definition at line 164 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;
}

processSceneDictionary:atOffset:

- (BOOL) processSceneDictionary:		(NSDictionary *)	couplet
atOffset:		(Vector)	off

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                               :(NSDictionary *) couplet atOffset:(Vector) off
{
    NSArray *conditions = [couplet objectForKey:@"conditions"];
    NSArray *actions = nil;
    if ([couplet objectForKey:@"do"])
        actions = [NSArray arrayWithObject: [couplet objectForKey:@"do"]];
    NSArray *else_actions = nil;
    if ([couplet objectForKey:@"else"])
        else_actions = [NSArray arrayWithObject: [couplet objectForKey:@"else"]];
    BOOL success = YES;
    if (conditions == nil)
    {
        OOLog(@"script.scene.couplet.badConditions", @"***** SCENE ERROR: %@ - conditions not %@, returning %@.", [couplet description], @" found",@"YES and performing 'do' actions");
    }
    else
    {
        if (![conditions isKindOfClass:[NSArray class]])
        {
            OOLog(@"script.scene.couplet.badConditions", @"***** SCENE ERROR: %@ - conditions not %@, returning %@.", [conditions description], @"an array",@"NO");
            return NO;
        }
    }
 
    // check conditions..
    success = TestScriptConditions(OOSanitizeLegacyScriptConditions(conditions, @"<scene dictionary conditions>"));
 
    // perform successful actions...
    if ((success) && (actions) && [actions count])
        [self addScene: actions atOffset: off];
 
    // perform unsuccessful actions
    if ((!success) && (else_actions) && [else_actions count])
        [self addScene: else_actions atOffset: off];
 
    return success;
}

processSceneString:atOffset:

- (BOOL) processSceneString:		(NSString*)	item
atOffset:		(Vector)	off

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                           :(NSString*) item atOffset:(Vector) off
{
    Vector  model_p0;
    Quaternion  model_q;
    
    if (!item)
        return NO;
    NSArray * i_info = ScanTokensFromString(item);
    if (!i_info)
        return NO;
    NSString* i_key = [(NSString*)[i_info objectAtIndex:0] lowercaseString];
 
    OOLog(kOOLogNoteProcessSceneString, @"..... processing %@ (%@)", i_info, i_key);
 
    //
    // recursively add further scenes:
    //
    if ([i_key isEqualToString:@"scene"])
    {
        if ([i_info count] != 5)    // must be scene_key_x_y_z
            return NO;              //         0.... 1.. 2 3 4
        NSString* scene_key = (NSString*)[i_info objectAtIndex: 1];
        Vector  scene_offset = {0};
        ScanVectorFromString([[i_info subarrayWithRange:NSMakeRange(2, 3)] componentsJoinedByString:@" "], &scene_offset);
        scene_offset.x += off.x;    scene_offset.y += off.y;    scene_offset.z += off.z;
        NSArray * scene_items = (NSArray *)[[UNIVERSE descriptions] objectForKey:scene_key];
        OOLog(kOOLogDebugProcessSceneStringAddScene, @"::::: adding scene: '%@'", scene_key);
        //
        if (scene_items)
        {
            [self addScene: scene_items atOffset: scene_offset];
            return YES;
        }
        else
            return NO;
    }
    //
    // Add ship models:
    //
    if ([i_key isEqualToString:@"ship"]||[i_key isEqualToString:@"model"]||[i_key isEqualToString:@"role"])
    {
        if ([i_info count] != 10)   // must be item_name_x_y_z_W_X_Y_Z_align
        {
            return NO;              //         0... 1... 2 3 4 5 6 7 8 9....
        }
        
        ShipEntity* ship = nil;
        
        if ([i_key isEqualToString:@"ship"]||[i_key isEqualToString:@"model"])
        {
            ship = [UNIVERSE newShipWithName:[i_info oo_stringAtIndex: 1]];
        }
        else if ([i_key isEqualToString:@"role"])
        {
            ship = [UNIVERSE newShipWithRole:[i_info oo_stringAtIndex: 1]];
        }
        if (!ship)
            return NO;
 
        ScanVectorAndQuaternionFromString([[i_info subarrayWithRange:NSMakeRange(2, 7)] componentsJoinedByString:@" "], &model_p0, &model_q);
        
        Vector  model_offset = positionOffsetForShipInRotationToAlignment(ship, model_q, [i_info oo_stringAtIndex:9]);
        model_p0 = vector_add(model_p0, vector_subtract(off, model_offset));
 
        OOLog(kOOLogDebugProcessSceneStringAddModel, @"::::: adding model to scene:'%@'", ship);
        [ship setOrientation: model_q];
        [ship setPosition: vectorToHPVector(model_p0)];
        [UNIVERSE setMainLightPosition:(Vector){ DEMO_LIGHT_POSITION }]; // set light origin
        [ship setScanClass: CLASS_NO_DRAW];
        [ship switchAITo: @"nullAI.plist"];
        [UNIVERSE addEntity: ship]; // STATUS_IN_FLIGHT, AI state GLOBAL
        [ship setStatus: STATUS_COCKPIT_DISPLAY];
        [ship setRoll: 0.0];
        [ship setPitch: 0.0];
        [ship setVelocity: kZeroVector];
        [ship setBehaviour: BEHAVIOUR_STOP_STILL];
 
        [ship release];
        return YES;
    }
    //
    // Add player ship model:
    //
    if ([i_key isEqualToString:@"player"])
    {
        if ([i_info count] != 9)    // must be player_x_y_z_W_X_Y_Z_align
            return NO;              //         0..... 1 2 3 4 5 6 7 8....
 
        ShipEntity* doppelganger = [UNIVERSE newShipWithName:[self shipDataKey]];   // retain count = 1
        if (!doppelganger)
            return NO;
        
        ScanVectorAndQuaternionFromString([[i_info subarrayWithRange:NSMakeRange( 1, 7)] componentsJoinedByString:@" "], &model_p0, &model_q);
        
        Vector  model_offset = positionOffsetForShipInRotationToAlignment( doppelganger, model_q, (NSString*)[i_info objectAtIndex:8]);
        model_p0.x += off.x - model_offset.x;
        model_p0.y += off.y - model_offset.y;
        model_p0.z += off.z - model_offset.z;
 
        OOLog(kOOLogDebugProcessSceneStringAddModel, @"::::: adding model to scene:'%@'", doppelganger);
        [doppelganger setOrientation: model_q];
        [doppelganger setPosition: vectorToHPVector(model_p0)];
        [UNIVERSE setMainLightPosition:(Vector){ DEMO_LIGHT_POSITION }]; // set light origin
        [doppelganger setScanClass: CLASS_NO_DRAW];
        [doppelganger switchAITo: @"nullAI.plist"];
        [UNIVERSE addEntity: doppelganger];
        [doppelganger setStatus: STATUS_COCKPIT_DISPLAY];
        [doppelganger setRoll: 0.0];
        [doppelganger setPitch: 0.0];
        [doppelganger setVelocity: kZeroVector];
        [doppelganger setBehaviour: BEHAVIOUR_STOP_STILL];
 
        [doppelganger release];
        return YES;
    }
    //
    // Add  planet model: selected via gui-scene-show-planet/-local-planet
    //
    if ([i_key isEqualToString:@"local-planet"] || [i_key isEqualToString:@"target-planet"])
    {
        if ([i_info count] != 4)    // must be xxxxx-planet_x_y_z
            return NO;              //         0........... 1 2 3
        
        // sunlight position for F7 screen is chosen pseudo randomly from  4 different positions.
        if (info_system_id & 8)
        {
            _sysInfoLight = (info_system_id & 2) ? (Vector){ -10000.0, 4000.0, -10000.0 } : (Vector){ -12000.0, -5000.0, -10000.0 };
        }
        else
        {
            _sysInfoLight = (info_system_id & 2) ? (Vector){ 6000.0, -5000.0, -10000.0 } : (Vector){ 6000.0, 4000.0, -10000.0 };
        }
 
        [UNIVERSE setMainLightPosition:_sysInfoLight]; // set light origin
        
#if NEW_PLANETS
        OOPlanetEntity *originalPlanet = nil;
        if ([i_key isEqualToString:@"local-planet"] && [UNIVERSE sun])
        {
            originalPlanet = [UNIVERSE planet];
        }
        else
        {
            originalPlanet = [[[OOPlanetEntity alloc] initAsMainPlanetForSystem:info_system_id] autorelease];
        }
        OOPlanetEntity *doppelganger = [originalPlanet miniatureVersion];
        if (doppelganger == nil)  return NO;
 
#else
        OOPlanetEntity* doppelganger = nil;
        NSMutableDictionary *planetInfo = [NSMutableDictionary dictionaryWithDictionary:[UNIVERSE generateSystemData:target_system_seed]];
        
        if ([i_key isEqualToString:@"local-planet"] && [UNIVERSE sun])
        {
            OOPlanetEntity *mainPlanet = [UNIVERSE planet];
            OOTexture *texture = [mainPlanet texture];
            if (texture != nil)
            {
                [planetInfo setObject:texture forKey:@"_oo_textureObject"];
                [planetInfo oo_setBool:[mainPlanet isExplicitlyTextured] forKey:@"_oo_isExplicitlyTextured"];
                [planetInfo oo_setBool:YES forKey:@"mainForLocalSystem"];
                //[planetInfo oo_setQuaternion:[mainPlanet orientation] forKey:@"orientation"]; // the orientation is overwritten later on, without regard for the real planet's orientation.
            }
        }
        
        doppelganger = [[OOPlanetEntity alloc] initFromDictionary:planetInfo withAtmosphere:YES andSeed:target_system_seed];
        [doppelganger miniaturize];
        [doppelganger autorelease];
        
        if (doppelganger == nil)  return NO;
#endif
        
        ScanVectorFromString([[i_info subarrayWithRange:NSMakeRange(1, 3)] componentsJoinedByString:@" "], &model_p0);
        
        // miniature radii are roughly between 60 and 120. Place miniatures with a radius bigger than 60 a bit futher away.
        model_p0 = vector_multiply_scalar(model_p0, 1 - 0.5 * ((60 - [doppelganger radius]) / 60));
        
        model_p0 = vector_add(model_p0, off);
        
        // TODO: find better quaternion values.     
#if NEW_PLANETS
        //Quaternion model_q = { 0.83, 0.365148, 0.182574, 0.0 }; // shows new planets' north pole.
        //Quaternion model_q = { 0.83, -0.365148, 0.182574, 0.0 }; // shows new planets' south pole.
        Quaternion model_q = { 0.83, 0.12, 0.44, 0.0 }; // new planets - default orientation.
#else
        //model_q = make_quaternion( M_SQRT1_2, 0.314, M_SQRT1_2, 0.0 );
        Quaternion model_q = { 0.833492, 0.333396, 0.440611, 0.0 }; 
#endif
        OOLog(kOOLogDebugProcessSceneStringAddMiniPlanet, @"::::: adding %@ to scene:'%@'", i_key, doppelganger);
        [doppelganger setOrientation: model_q];
        // HPVect: mission screen coordinates are small enough that we don't need high-precision for calculations
        [doppelganger setPosition: vectorToHPVector(model_p0)];
        /* MKW - add rotation based on current time 
         *     - necessary to duplicate the rotation already performed in PlanetEntity.m since we reset the orientation above. */
        int     deltaT = floor(fmod([self clockTimeAdjusted], 86400));
        [doppelganger update: deltaT];
        [UNIVERSE addEntity:doppelganger];
        
        return YES;
    }
    
    return NO;
}

pseudoFixedD100_number

- (NSNumber *) pseudoFixedD100_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:[self systemPseudoRandom100]];
}

pseudoFixedD256_number

- (NSNumber *) pseudoFixedD256_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:[self systemPseudoRandom256]];
}

quicksavePlayer

- (void) quicksavePlayer

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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];
}

random_factor

- (int) random_factor

Definition at line 13727 of file PlayerEntity.m.

{
    return market_rnd;
}

realAlertCondition

- (OOAlertCondition) realAlertCondition

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    return [self alertCondition];
}

receiveCommsMessage:from:

- (void) receiveCommsMessage: (NSString *)  message_text from: (ShipEntity *)  other

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                            :(NSString *) message_text from:(ShipEntity *) other
{
    if ([self status] == STATUS_DEAD || [self status] == STATUS_DOCKED)
    {
        // only when in flight
        return;
    }
    [UNIVERSE addCommsMessage:[NSString stringWithFormat:@"%@:\n %@", [other displayName], message_text] forCount:4.5];
    [super receiveCommsMessage:message_text from:other];
}

RecursiveRemapStatus

- (OOINLINE OOEntityStatus) RecursiveRemapStatus (OOEntityStatus)  status

implementation

Provided by category PlayerEntity(Scripting).

Definition at line 260 of file PlayerEntityLegacyScriptEngine.m.

{
    // Some player stutuses should only be seen once per "event".
    // This remaps them to something innocuous in case of recursion.
    if (status == STATUS_DOCKING ||
        status == STATUS_LAUNCHING ||
        status == STATUS_ENTERING_WITCHSPACE ||
        status == STATUS_EXITING_WITCHSPACE)
    {
        return STATUS_IN_FLIGHT;
    }
    else
    {
        return status;
    }
}

refreshMissionScreenTextEntry

- (void) refreshMissionScreenTextEntry

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
    NSUInteger end_row = 21;
    if ([[self hud] allowBigGui]) 
    {
        end_row = 27;
    }
 
    [gui setText:[NSString stringWithFormat:DESC(@"mission-screen-text-prompt-@"), [gameView typedString]] forRow:end_row align:GUI_ALIGN_LEFT];
    [gui setColor:[OOColor cyanColor] forRow:end_row];
    
    [gui setShowTextCursor:YES];
    [gui setCurrentRow:end_row];
 
}

reloadPage

- (void) reloadPage

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

{
    // Update the GUI (this will refresh the function list).
    unsigned skip;
    if (selFunctionIdx < MAX_ROWS_KC_FUNCTIONS - 1)
    {
        skip = 0;
    }
    else
    {
        skip = ((selFunctionIdx - 1) / (MAX_ROWS_KC_FUNCTIONS - 2)) * (MAX_ROWS_KC_FUNCTIONS - 2) + 1;
    }
    
    [self setGuiToKeyMapperScreen:skip];
}

removeAllCargo

- (void) removeAllCargo

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    [self removeAllCargo:NO];
}

Referenced by PlayerShipRemoveAllCargo().

Here is the caller graph for this function:

removeAllCargo:

- (void) removeAllCargo:

(BOOL)

forceRemoval

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                       :(BOOL)forceRemoval
{
    // Misnamed method. It only removes cargo measured in TONS, g & Kg items are not removed. --Kaks 20091004
    OOCommodityType         type;
    
    if (scriptTarget != self)  return;
    
    if ([self status] != STATUS_DOCKED && !forceRemoval)
    {
        OOLogWARN(kOOLogRemoveAllCargoNotDocked, @"%@removeAllCargo only works when docked.", [NSString stringWithFormat:@" in %@, ", CurrentScriptDesc()]);
        return;
    }
    
    OOLog(kOOLogNoteRemoveAllCargo, @"%@ removeAllCargo", forceRemoval ? @"Forcing" : @"Going to");
    
    foreach (type, [shipCommodityData goods])
    {
        if ([shipCommodityData massUnitForGood:type] == UNITS_TONS)
        {
            [shipCommodityData setQuantity:0 forGood:type];
        }
    }
 
 
    if (forceRemoval && [self status] != STATUS_DOCKED)
    {
        NSInteger i;
        for (i = [cargo count] - 1; i >= 0; i--)
        {
            ShipEntity* canister = [cargo objectAtIndex:i];
            if (!canister)  break;
            // Since we are forcing cargo removal, we don't really care about the unit of measurement. Any
            // commodity at more than 1000kg or 1000000gr will be inside cargopods, so remove those too.
            [cargo removeObjectAtIndex:i];
        }
    }
    
    DESTROY(specialCargo);
    
    [self calculateCurrentCargo];
}

removeContract:destination:

- (BOOL) removeContract:		(NSString*)	commodity
destination:		(unsigned)	destination

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                       :(OOCommodityType)type destination:(unsigned)dest    // removes the first match found, returns NO if none found
{
    if ([contracts count] == 0 || dest > 255)  return NO;
 
    if (![[UNIVERSE commodities] goodDefined:type])  return NO;
    
    unsigned            i;
    
    for (i = 0; i < [contracts count]; i++)
    {
        NSDictionary        *contractInfo = [contracts oo_dictionaryAtIndex:i];
        unsigned            cargoDest = [contractInfo oo_intForKey:CONTRACT_KEY_DESTINATION];
        OOCommodityType     cargoType = [contractInfo oo_stringForKey:CARGO_KEY_TYPE];
        
        if ([cargoType isEqualToString:type] && cargoDest == dest)
        {
            [contract_record removeObjectForKey:[contractInfo oo_stringForKey:CARGO_KEY_ID]];
            [contracts removeObjectAtIndex:i];
            return YES;
        }
    }
    
    return NO;
}

Referenced by PlayerShipRemoveContract().

Here is the caller graph for this function:

removeEqScriptForKey:

- (void) removeEqScriptForKey:

(NSString *)

eq_key

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                             :(NSString *)eq_key
{
    if (eq_key == nil) return;
    
    NSString            *key = nil;
    NSUInteger          i, count = [eqScripts count];
    
    for (i = 0; i < count; i++)
    {
        key = [[eqScripts oo_arrayAtIndex:i] oo_stringAtIndex:0];
        if ([key isEqualToString: eq_key]) 
        {
            [eqScripts removeObjectAtIndex:i];
            
            if (i == primedEquipment)  primedEquipment = count; // primed-none
            else if (i < primedEquipment)  primedEquipment--; // track the primed equipment
            if (count == primedEquipment)  primedEquipment--; // the array has shrunk by one!
 
            OOLog(@"player.equipmentScript", @"Removed equipment %@, with the following script property: '%@'.", eq_key, [[OOEquipmentType equipmentTypeWithIdentifier:eq_key] scriptName]);
        }
    }
}

removeEquipment:

- (void) removeEquipment:

(NSString *)

equipString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)equipKey  //eg. EQ_NAVAL_ENERGY_UNIT
{
    if (scriptTarget != self)  return;
 
    if ([equipKey isEqualToString:@"EQ_FUEL"])
    {
        fuel = 0;
        return;
    }
    
    if ([equipKey isEqualToString:@"EQ_CARGO_BAY"] && [self hasEquipmentItem:equipKey]
            && ([self extraCargo] > [self availableCargoSpace]))
    {
        OOLog(kOOLogSyntaxRemoveEquipment, @"***** SCRIPT ERROR: in %@, CANNOT remove cargo bay. Too much cargo.", CurrentScriptDesc());
        return;
    }
    if ([self hasEquipmentItem:equipKey] || [self hasEquipmentItem:[equipKey stringByAppendingString:@"_DAMAGED"]])
    {
        [self removeEquipmentItem:equipKey];
    }
 
}

removeEquipmentItem:

- (void) removeEquipmentItem: (NSString *)  equipmentKey

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                            :(NSString *)equipmentKey
{
    if(![self hasEquipmentItemProviding:@"EQ_ADVANCED_COMPASS"] && [self compassMode] != COMPASS_MODE_BASIC)
    {
        [self setCompassMode:COMPASS_MODE_BASIC];
    }
    [super removeEquipmentItem:equipmentKey];
    if(![self hasEquipmentItem:equipmentKey]) {
        // removed the last one
        [self removeEqScriptForKey:equipmentKey];
    }
}

removeExternalStore:

- (BOOL) removeExternalStore: (OOEquipmentType *)  eqType

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                            :(OOEquipmentType *)eqType
{
    NSString    *identifier = [eqType identifier];
    
    // Look for matching missile.
    unsigned i;
    for (i = 0; i < max_missiles; i++)
    {
        if ([[self missileForPylon:i] hasPrimaryRole:identifier])
        {
            [self removeFromPylon:i];
            
            // Just remove one at a time.
            return YES;
        }
    }
    return NO;
}

removeFromPylon:

- (BOOL) removeFromPylon:

(NSUInteger)

pylon

Definition at line 9242 of file PlayerEntity.m.

                        :(NSUInteger)pylon
{
    if (pylon >= max_missiles) return NO;
    
    if (missile_entity[pylon] != nil)
    {
        NSString    *identifier = [missile_entity[pylon] primaryRole];
        [super removeExternalStore:[OOEquipmentType equipmentTypeWithIdentifier:identifier]];
 
        // Remove the missile (must wait until we've finished with its identifier string!)
        [missile_entity[pylon] release];
        missile_entity[pylon] = nil;
        
        [self tidyMissilePylons];
        
        // This should be the currently selected missile, deselect it.
        if (pylon <= activeMissile)
        {
            if (activeMissile == missiles && missiles > 0) activeMissile--;
            if (activeMissile > 0) activeMissile--;
            else activeMissile = max_missiles - 1;
            
            [self selectNextMissile];
        }
        
        return YES;
    }
 
    return NO;
}

removeFunction:

- (void) removeFunction: (int)  idx

implementation

Provided by category PlayerEntity(StickMapperInternal).

Definition at line 1 of file PlayerEntityStickMapper.m.

                       :(int)idx
{
    OOJoystickManager   *stickHandler = [OOJoystickManager sharedStickHandler];
    NSDictionary        *entry = [stickFunctions objectAtIndex:idx];
    NSNumber            *butfunc = [entry objectForKey:KEY_BUTTONFN];
    NSNumber            *axfunc = [entry objectForKey:KEY_AXISFN];
    BOOL                custom = NO;
    selFunctionIdx = idx;
    
    // Some things can have either axis or buttons - make sure we clear
    // both!
    if(butfunc)
    {
        // special case for OXP equipment buttons
        if ([butfunc intValue] >= 10000) 
        {
            int bf = [butfunc intValue];
            custom = YES;
            NSString *key = CUSTOMEQUIP_BUTTONACTIVATE;
            bf -= 10000;
            if (bf >= 10000) 
            {
                bf -= 10000;
                key = CUSTOMEQUIP_BUTTONMODE;
            }
            NSMutableDictionary *custEquip = [[customEquipActivation objectAtIndex:bf] mutableCopy];
            if ([key isEqualToString:CUSTOMEQUIP_BUTTONACTIVATE] && [custEquip objectForKey:CUSTOMEQUIP_BUTTONACTIVATE]) [custEquip removeObjectForKey:key];
            if ([key isEqualToString:CUSTOMEQUIP_BUTTONMODE] && [custEquip objectForKey:CUSTOMEQUIP_BUTTONMODE]) [custEquip removeObjectForKey:key];
            [customEquipActivation replaceObjectAtIndex:bf withObject:custEquip];
            [custEquip release];
        }
        else 
        {
            [stickHandler unsetButtonFunction:[butfunc intValue]];
        }
    }
    if(axfunc)
    {
        [stickHandler unsetAxisFunction:[axfunc intValue]];
    }
    if (!custom) 
    {
        [stickHandler saveStickSettings];
    }
    else 
    {
        NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
        [defaults setObject:customEquipActivation forKey:KEYCONFIG_CUSTOMEQUIP];
    }
    
    unsigned skip;
    if (selFunctionIdx < MAX_ROWS_FUNCTIONS - 1)
        skip = 0;
    else
        skip = ((selFunctionIdx - 1) / (MAX_ROWS_FUNCTIONS - 2)) * (MAX_ROWS_FUNCTIONS - 2) + 1;
    [self setGuiToStickMapperScreen: skip];
}

removeMissiles

- (OOCreditsQuantity) removeMissiles

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

{
    [self safeAllMissiles];
    OOCreditsQuantity tradeIn = 0;
    unsigned i;
    for (i = 0; i < missiles; i++)
    {
        NSString *weapon_key = [missile_list[i] identifier];
        
        if (weapon_key != nil)
            tradeIn += (int)[UNIVERSE getEquipmentPriceForKey:weapon_key];
    }
    
    for (i = 0; i < max_missiles; i++)
    {
        [missile_entity[i] release];
        missile_entity[i] = nil;
    }
    
    missiles = 0;
    return tradeIn;
}

Referenced by ShipAwardEquipment().

Here is the caller graph for this function:

removeMissionDestination:

- (void) removeMissionDestination:

(NSString *)

destinations

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                                 :(NSString *)destinations
{
    unsigned            j;
    int                 dest;
    NSMutableArray      *tokens = ScanTokensFromString(destinations);
 
    for (j = 0; j < [tokens count]; j++)
    {
        dest = [[tokens objectAtIndex:j] intValue];
        if (dest < 0 || dest > 255)  continue;
 
        [self removeMissionDestinationMarker:[self defaultMarker:dest]];
    }
}

removeMissionDestinationMarker:

- (BOOL) removeMissionDestinationMarker:

(NSDictionary *)

marker

Definition at line 9242 of file PlayerEntity.m.

                                       :(NSDictionary *)marker
{
    NSDictionary *validated = [self validatedMarker:marker];
    if (validated == nil) 
    {
        return NO;
    }
    BOOL result = NO;
    if ([missionDestinations objectForKey:[self markerKey:validated]] != nil) {
        result = YES;
    }
    [missionDestinations removeObjectForKey:[self markerKey:validated]];
    return result;
}

removeParcel:

- (BOOL) removeParcel:

(NSString*)

Name

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                     :(NSString*)Name   // removes the first parcel that answers to Name, returns NO if none found
{   
    // extra check, just in case.
    if ([parcels count] == 0) return NO;
    
    unsigned            i;
    
    for (i = 0; i < [parcels count]; i++)
    {
        NSString        *this_name = [[parcels oo_dictionaryAtIndex:i] oo_stringForKey:PASSENGER_KEY_NAME];
        
        if ([Name isEqualToString:this_name])
        {
            [parcels removeObjectAtIndex:i];
            [parcel_record removeObjectForKey:Name];
            return YES;
        }
    }
    
    return NO;
}

Referenced by PlayerShipRemoveParcel().

Here is the caller graph for this function:

removePassenger:

- (BOOL) removePassenger:

(NSString*)

Name

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                        :(NSString*)Name    // removes the first passenger that answers to Name, returns NO if none found
{   
    // extra check, just in case.
    if ([passengers count] == 0) return NO;
    
    unsigned            i;
    
    for (i = 0; i < [passengers count]; i++)
    {
        NSString        *this_name = [[passengers oo_dictionaryAtIndex:i] oo_stringForKey:PASSENGER_KEY_NAME];
        
        if ([Name isEqualToString:this_name])
        {
            [passengers removeObjectAtIndex:i];
            [passenger_record removeObjectForKey:Name];
            return YES;
        }
    }
    
    return NO;
}

Referenced by PlayerShipRemovePassenger().

Here is the caller graph for this function:

removeTrumble:

- (void) removeTrumble:

(OOTrumble *)

deadTrumble

Definition at line 9242 of file PlayerEntity.m.

                      :(OOTrumble *)deadTrumble
{
    if (trumbleCount <= 0)
    {
        return;
    }
    NSUInteger  trumble_index = NSNotFound;
    NSUInteger  i;
    
    for (i = 0; (trumble_index == NSNotFound)&&(i < trumbleCount); i++)
    {
        if (trumble[i] == deadTrumble)
            trumble_index = i;
    }
    if (trumble_index == NSNotFound)
    {
        OOLog(@"trumble.zombie", @"DEBUG can't get rid of inactive trumble %@", deadTrumble);
        return;
    }
    trumbleCount--; // reduce number of trumbles
    trumble[trumble_index] = trumble[trumbleCount]; // swap with the current last trumble
    trumble[trumbleCount] = deadTrumble;                // swap with the current last trumble
}

renovationCosts

- (double) renovationCosts

Definition at line 9242 of file PlayerEntity.m.

{
    // 5% of value of ships wear + correction for missing subentities.
    OOCreditsQuantity shipValue = [UNIVERSE tradeInValueForCommanderDictionary:[self commanderDataDictionary]];
 
    double costs = 0.005 * (100 - ship_trade_in_factor) * shipValue;
    costs += 0.01 * shipValue * [self missingSubEntitiesAdjustment];
    costs *= [self renovationFactor];
    return cunningFee(costs, 0.05);
}

renovationFactor

- (double) renovationFactor

Definition at line 9242 of file PlayerEntity.m.

{
    OOShipRegistry      *registry = [OOShipRegistry sharedRegistry];
    NSDictionary        *shipyardInfo = [registry shipyardInfoForKey:[self shipDataKey]];
    return [shipyardInfo oo_doubleForKey:KEY_RENOVATION_MULTIPLIER defaultValue:1.0];
}

replaceShipWithNamedShip:

- (BOOL) replaceShipWithNamedShip:

(NSString *)

shipName

Provided by category PlayerEntity(Contracts).

Definition at line 1443 of file PlayerEntityContracts.m.

                                 :(NSString *)shipKey
{
 
    NSDictionary *ship_info = [[OOShipRegistry sharedRegistry] shipyardInfoForKey:shipKey];
    
    NSDictionary *ship_base_dict = [[OOShipRegistry sharedRegistry] shipInfoForKey:shipKey];
 
    if (ship_info == nil || ship_base_dict == nil) {
        return NO;
    }
 
    // from this point, the player is committed to replacing - raise a pre-replace script event
    [self doScriptEvent:OOJSID("playerWillReplaceShip") withArgument:shipKey];
 
    [self newShipCommonSetup:shipKey yardInfo:ship_info baseInfo:ship_base_dict];
 
    // perform the transformation
    NSDictionary* cmdr_dict = [self commanderDataDictionary];   // gather up all the info
    if (![self setCommanderDataFromDictionary:cmdr_dict])  return NO;
 
    // refill from ship_info
    NSArray* extras = [NSMutableArray arrayWithArray:[[ship_info oo_dictionaryForKey:KEY_STANDARD_EQUIPMENT] oo_arrayForKey:KEY_EQUIPMENT_EXTRAS]];
    for (unsigned i = 0; i < [extras count]; i++)
    {
        NSString* eq_key = [extras oo_stringAtIndex:i];
        if ([eq_key isEqualToString:@"EQ_PASSENGER_BERTH"])
        {
            max_passengers++;
            max_cargo -= PASSENGER_BERTH_SPACE;
        }
        else
        {
            [self addEquipmentItem:eq_key withValidation:YES inContext:@"newShip"]; 
        }
    }
 
    [self setEntityPersonalityInt:[ship_info oo_unsignedShortForKey:SHIPYARD_KEY_PERSONALITY]];
    
    return YES;
}

Referenced by PlayerReplaceShip().

Here is the caller graph for this function:

replaceVariablesInString:

- (NSString *) replaceVariablesInString:

(NSString*)

args

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                                      :(NSString*) args
{
    NSMutableDictionary *locals = [self localVariablesForMission:sCurrentMissionKey];
    NSMutableString     *resultString = [NSMutableString stringWithString: args];
    NSString            *valueString;
    unsigned            i;
    NSMutableArray      *tokens = ScanTokensFromString(args);
    
    for (i = 0; i < [tokens  count]; i++)
    {
        valueString = [tokens objectAtIndex:i];
        
        if ([valueString hasPrefix:@"mission_"] && [mission_variables objectForKey:valueString])
        {
            [resultString replaceOccurrencesOfString:valueString withString:[mission_variables objectForKey:valueString] options:NSLiteralSearch range:NSMakeRange(0, [resultString length])];
        }
        else if ([locals objectForKey:valueString])
        {
            [resultString replaceOccurrencesOfString:valueString withString:[locals objectForKey:valueString] options:NSLiteralSearch range:NSMakeRange(0, [resultString length])];
        }
        else if (([valueString hasSuffix:@"_number"])||([valueString hasSuffix:@"_bool"])||([valueString hasSuffix:@"_string"]))
        {
            SEL valueselector = NSSelectorFromString(valueString);
            if ([self respondsToSelector:valueselector])
            {
                [resultString replaceOccurrencesOfString:valueString withString:[NSString stringWithFormat:@"%@", [self performSelector:valueselector]] options:NSLiteralSearch range:NSMakeRange(0, [resultString length])];
            }
        }
        else if ([valueString hasPrefix:@"["]&&[valueString hasSuffix:@"]"])
        {
            NSString* replaceString = OOExpand(valueString);
            [resultString replaceOccurrencesOfString:valueString withString:replaceString options:NSLiteralSearch range:NSMakeRange(0, [resultString length])];
        }
    }
    
    OOLog(kOOLogDebugReplaceVariablesInString, @"EXPANSION: \"%@\" becomes \"%@\"", args, resultString);
    
    return [NSString stringWithString: resultString];
}

requestDockingClearance:

- (void) requestDockingClearance:

(StationEntity *)

stationForDocking

Definition at line 13727 of file PlayerEntity.m.

                                :(StationEntity *)stationForDocking
{
    if (dockingClearanceStatus != DOCKING_CLEARANCE_STATUS_REQUESTED && dockingClearanceStatus != DOCKING_CLEARANCE_STATUS_GRANTED)
    {
        [self performDockingRequest:stationForDocking];
    }
}

Referenced by PlayerShipRequestDockingClearance().

Here is the caller graph for this function:

reset:

- (void) reset:

(NSString *)

missionvariable

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

              :(NSString *)missionvariable
{
    NSString*   missionVariableString = [missionvariable stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
    BOOL hasMissionPrefix, hasLocalPrefix;
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
 
    if (hasMissionPrefix)
    {
        [self setMissionVariable:nil forKey:missionVariableString];
    }
    else if (hasLocalPrefix)
    {
        [self setLocalVariable:nil forKey:missionVariableString andMission:sCurrentMissionKey];
    }
    else
    {
        OOLog(kOOLogSyntaxReset, @"***** SCRIPT ERROR: in %@, IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString);
    }
}

resetAutopilotAI

- (void) resetAutopilotAI

Definition at line 13727 of file PlayerEntity.m.

{
    AI *myAI = [self getAI];
    // JSAI: will need changing if oolite-dockingAI.js written
    if (![[myAI name] isEqualToString:PLAYER_DOCKING_AI_NAME])
    {
        [self setAITo:PLAYER_DOCKING_AI_NAME ];
    }
    [myAI clearAllData];
    [myAI setState:@"GLOBAL"];
    [myAI setNextThinkTime:[UNIVERSE getTime] + 2];
    [myAI setOwner:self];
}

resetCustomView

- (void) resetCustomView

Definition at line 9242 of file PlayerEntity.m.

{
    [self setCustomViewDataFromDictionary:[_customViews oo_dictionaryAtIndex:_customViewIndex] withScaling:NO];
}

Referenced by PlayerShipResetCustomView().

Here is the caller graph for this function:

resetHud

- (void) resetHud

Definition at line 13727 of file PlayerEntity.m.

{
    // set up defauld HUD for the ship
    NSDictionary *shipDict = [[OOShipRegistry sharedRegistry] shipInfoForKey:[self shipDataKey]];
    NSString *hud_desc = [shipDict oo_stringForKey:@"hud" defaultValue:@"hud.plist"];
    if (![self switchHudTo:hud_desc])  [self switchHudTo:@"hud.plist"]; // ensure we have a HUD to fall back to
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

resetKeyFunctions

- (void) resetKeyFunctions

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

{
    [keyFunctions release];
    keyFunctions = nil;
}

resetMissionChoice

- (void) resetMissionChoice

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    [self setMissionChoice:nil];
}

resetScannerZoom

- (void) resetScannerZoom

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    scanner_zoom_rate = SCANNER_ZOOM_RATE_DOWN;
}

Referenced by PlayerShipResetScannerZoom().

Here is the caller graph for this function:

resetScriptTimer

- (void) resetScriptTimer

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    script_time = 0.0;
    script_time_check = SCRIPT_TIMER_INTERVAL;
    script_time_interval = SCRIPT_TIMER_INTERVAL;
}

resetStickFunctions

- (void) resetStickFunctions

Provided by category PlayerEntity(StickMapperInternal).

Definition at line 1 of file PlayerEntityStickMapper.m.

{
    [stickFunctions release];
    stickFunctions = nil;
}

roleWeights

- (NSMutableArray *) roleWeights

rotateCargo

- (void) rotateCargo

Definition at line 13727 of file PlayerEntity.m.

{
    NSInteger i, n_cargo = [cargo count];
    if (n_cargo == 0)  return;
    
    ShipEntity *pod = (ShipEntity *)[[cargo objectAtIndex:0] retain];
    OOCommodityType current_contents = [pod commodityType];
    OOCommodityType contents;
    NSInteger rotates = 0;
    
    do
    {
        [cargo removeObjectAtIndex:0];  // take it from the eject position
        [cargo addObject:pod];  // move it to the last position
        [pod release];
        pod = (ShipEntity*)[[cargo objectAtIndex:0] retain];
        contents = [pod commodityType];
        rotates++;
    } while ([contents isEqualToString:current_contents]&&(rotates < n_cargo));
    [pod release];
    
    NSString *commodity = [UNIVERSE displayNameForCommodity:contents];
    [UNIVERSE addMessage:OOExpandKey(@"ready-to-eject-commodity", commodity) forCount:3.0];
 
    // now scan through the remaining 1..(n_cargo - rotates) places moving similar cargo to the last place
    // this means the cargo gets to be sorted as it is rotated through
    for (i = 1; i < (n_cargo - rotates); i++)
    {
        pod = [cargo objectAtIndex:i];
        if ([[pod commodityType] isEqualToString:current_contents])
        {
            [pod retain];
            [cargo removeObjectAtIndex:i--];
            [cargo addObject:pod];
            [pod release];
            rotates++;
        }
    }
}

runScriptActions:withContextName:forTarget:

- (void) runScriptActions:		(NSArray *)	sanitizedActions
withContextName:		(NSString *)	contextName
forTarget:		(ShipEntity *)	target

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSArray *)actions withContextName:(NSString *)contextName forTarget:(ShipEntity *)target
{
    NSAutoreleasePool       *pool = nil;
    NSString                *oldMissionKey = nil;
    NSString * volatile     theMissionKey = contextName;    // Work-around for silly exception macros
    
    pool = [[NSAutoreleasePool alloc] init];
    
    // FIXME: does this actually make sense in the context of non-missions?
    oldMissionKey = sCurrentMissionKey;
    sCurrentMissionKey = theMissionKey;
    
    @try
    {
        PerformScriptActions(actions, target);
    }
    @catch (NSException *exception)
    {
        OOLog(@"script.error.exception",
              @"***** EXCEPTION %@: %@ while handling legacy script actions for %@",
              [exception name],
              [exception reason],
              [theMissionKey hasPrefix:kActionTempPrefix] ? [target shortDescription] : theMissionKey);
        // Suppress exception
    }
    
    sCurrentMissionKey = oldMissionKey;
    [pool release];
}

runUnsanitizedScriptActions:allowingAIMethods:withContextName:forTarget:

- (void) runUnsanitizedScriptActions:		(NSArray *)	unsanitizedActions
allowingAIMethods:		(BOOL)	allowAIMethods
withContextName:		(NSString *)	contextName
forTarget:		(ShipEntity *)	target

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                                    :(NSArray *)actions allowingAIMethods:(BOOL)allowAIMethods withContextName:(NSString *)contextName forTarget:(ShipEntity *)target
{
    [self runScriptActions:OOSanitizeLegacyScript(actions, contextName, allowAIMethods)
           withContextName:contextName
                 forTarget:target];
}

Referenced by ShipRunLegacyScriptActions().

Here is the caller graph for this function:

safeAllMissiles

- (void) safeAllMissiles

Definition at line 13727 of file PlayerEntity.m.

{
    //  sets all missile targets to NO_TARGET
    
    unsigned i;
    for (i = 0; i < max_missiles; i++)
    {
        if (missile_entity[i] && [missile_entity[i] primaryTarget] != nil)
            [missile_entity[i] removeTarget:nil];
    }
    missile_status = MISSILE_STATUS_SAFE;
}

Referenced by StationDockPlayer().

Here is the caller graph for this function:

saveCommanderInputHandler

- (void) saveCommanderInputHandler

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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];
    }
}

saveKeySetting:

- (void) saveKeySetting: (NSString*)  key

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                       :(NSString*)key
{
    // check for a blank entry
    if ([key_list count] > 1 && [[(NSDictionary*)[key_list objectAtIndex:1] objectForKey:@"key"] integerValue] == 0) 
    {
        [key_list removeObjectAtIndex:1];
    }
    // make sure the primary and alternate keys are different
    if ([key_list count] > 1) {
        if ([self compareKeyEntries:[key_list objectAtIndex:0] second:[key_list objectAtIndex:1]])
        {
            [key_list removeObjectAtIndex:1];
        }
    }
    // see if we've set the key settings to blank - in which case, delete the override
    if ([[(NSDictionary*)[key_list objectAtIndex:0] objectForKey:@"key"] integerValue] == 0)
    {
        if ([key_list count] == 1 || ([key_list count] > 1 && [[(NSDictionary*)[key_list objectAtIndex:1] objectForKey:@"key"] isEqualToString:@""]))
        {
            [self deleteKeySetting:key];
            // reload settings
            [self initKeyConfigSettings];
            [self reloadPage];
            return;
        }
    }
 
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
 
    if (![self entryIsCustomEquip:key])
    {
        // if we've got the same settings as the default, revert to the default
        if ([self entryIsEqualToDefault:key])
        {
            [self deleteKeySetting:key];
            // reload settings
            [self initKeyConfigSettings];
            [self reloadPage];
            return;
        }
        NSMutableDictionary *keyconf = [NSMutableDictionary dictionaryWithDictionary:[defaults objectForKey:KEYCONFIG_OVERRIDES]];
        [keyconf setObject:key_list forKey:key];
        [defaults setObject:keyconf forKey:KEYCONFIG_OVERRIDES];
    }
    else 
    {
        NSUInteger idx = [self getCustomEquipIndex:key];
        NSString *custkey = [self getCustomEquipKeyDefType:key];
        NSMutableDictionary *custEquip = [[customEquipActivation objectAtIndex:idx] mutableCopy];
        [custEquip setObject:key_list forKey:custkey];
        [customEquipActivation replaceObjectAtIndex:idx withObject:custEquip];
        [defaults setObject:customEquipActivation forKey:KEYCONFIG_CUSTOMEQUIP];
    }
    // reload settings
    [self initKeyConfigSettings];
    [self reloadPage];
}

savePlayer

- (void) savePlayer

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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
}

scannedWormholes

- (NSArray *) scannedWormholes

scannerFuzziness

- (double) scannerFuzziness

Definition at line 13727 of file PlayerEntity.m.

{
    double fuzz = 0.0;
    
    /* Fuzziness from ECM bursts */
    if (last_ecm_time > 0.0)
    {
        double since = [UNIVERSE getTime] - last_ecm_time;
        if (since < SCANNER_ECM_FUZZINESS)
        {
            fuzz += (SCANNER_ECM_FUZZINESS - since) * (SCANNER_ECM_FUZZINESS - since) * 500.0;
        }
    }
    /* Other causes could go here */
    
    return fuzz;
}

scoopOverride

- (BOOL) scoopOverride

score

- (unsigned) score

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return ship_kills;
}

score_number

- (NSNumber *) score_number

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithUnsignedInt:[self score]];
}

screenModeStringForWidth:height:refreshRate:

- (NSString *) screenModeStringForWidth:		(unsigned)	inWidth
height:		(unsigned)	inHeight
refreshRate:		(float)	inRate

Definition at line 9242 of file PlayerEntity.m.

                                       :(unsigned)width height:(unsigned)height refreshRate:(float)refreshRate
{
    if (0.0f != refreshRate)
    {
        return OOExpandKey(@"gameoptions-fullscreen-with-refresh-rate", width, height, refreshRate);
    }
    else
    {
        return OOExpandKey(@"gameoptions-fullscreen", width, height);
    }
}

scriptActions:forTarget:missionKey:

- (void) scriptActions: (NSArray *)  actions forTarget: (ShipEntity *)  target missionKey: (NSString *)  missionKey

implementation

Provided by category PlayerEntity(ScriptingPrivate).

scriptsLoaded

- (BOOL) scriptsLoaded

Definition at line 9242 of file PlayerEntity.m.

{
    return worldScripts != nil && [worldScripts count] > 0;
}

scriptTarget

- (ShipEntity *) scriptTarget

Provided by category PlayerEntity(Scripting).

Definition at line 233 of file PlayerEntityLegacyScriptEngine.m.

{
    return scriptTarget;
}

scriptTestCondition:

- (BOOL) scriptTestCondition: (NSArray *)  scriptCondition

implementation

Provided by category PlayerEntity(ScriptingPrivate).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                            :(NSArray *)scriptCondition
{
    /*  Test a script condition sanitized by OOLegacyScriptWhitelist.
        
        A sanitized condition is an array of the form:
            (opType, rawString, selector, comparisonType, operandArray).
        
        opType and comparisonType are NSNumbers containing OOOperationType and
        OOComparisonType enumerators, respectively.
        
        rawString is the original textual representation of the condition for
        display purposes.
        
        selector is a string, either a method selector or a mission/local
        variable name.
        
        operandArray is an array of operands. Each operand is itself an array
        of two items: a boolean indicating whether it's a method selector
        (true) or a literal string (false), and a string.
        
        The special opType OP_FALSE doesn't require any other elements in the
        array. All other valid opTypes require the array to have five elements.
        
        For performance reasons, this method assumes the script condition will
        have been generated by OOSanitizeLegacyScriptConditions() and doesn't
        perform extensive validity checks.
    */
    
    OOOperationType             opType;
    NSString                    *selectorString = nil;
    SEL                         selector = NULL;
    OOComparisonType            comparator;
    NSArray                     *operandArray = nil;
    NSString                    *lhsString = nil;
    NSString                    *expandedRHS = nil;
    NSArray                     *rhsComponents = nil;
    NSString                    *rhsItem = nil;
    NSUInteger                  i, count;
    NSCharacterSet              *whitespace = nil;
    double                      lhsValue, rhsValue;
    BOOL                        lhsFlag, rhsFlag;
    
    opType = [scriptCondition oo_unsignedIntAtIndex:0];
    if (opType == OP_FALSE)  return NO;
    
    selectorString = [scriptCondition oo_stringAtIndex:2];
    comparator = [scriptCondition oo_unsignedIntAtIndex:3];
    operandArray = [scriptCondition oo_arrayAtIndex:4];
    
    // Transform mission/local var ops into string ops.
    if (opType == OP_MISSION_VAR)
    {
        sMissionStringValue = [mission_variables objectForKey:selectorString];
        selector = @selector(mission_string);
        opType = OP_STRING;
    }
    else if (opType == OP_LOCAL_VAR)
    {
        sMissionStringValue = [[self localVariablesForMission:sCurrentMissionKey] objectForKey:selectorString];
        selector = @selector(mission_string);
        opType = OP_STRING;
    }
    else
    {
        selector = NSSelectorFromString(selectorString);
    }
    
    expandedRHS = [self expandScriptRightHandSide:operandArray];
    
    if (opType == OP_STRING)
    {
        lhsString = [self performSelector:selector];
        
    #define DOUBLEVAL(x) ((x != nil) ? [x doubleValue] : 0.0)
        
        switch (comparator)
        {
            case COMPARISON_UNDEFINED:
                return lhsString == nil;
                
            case COMPARISON_EQUAL:
                return [lhsString isEqualToString:expandedRHS];
                
            case COMPARISON_NOTEQUAL:
                return ![lhsString isEqualToString:expandedRHS];
                
            case COMPARISON_LESSTHAN:
                return DOUBLEVAL(lhsString) < DOUBLEVAL(expandedRHS);
                
            case COMPARISON_GREATERTHAN:
                return DOUBLEVAL(lhsString) > DOUBLEVAL(expandedRHS);
                
            case COMPARISON_ONEOF:
                {
                    rhsComponents = [expandedRHS componentsSeparatedByString:@","];
                    count = [rhsComponents count];
                    
                    whitespace = [NSCharacterSet whitespaceCharacterSet];
                    lhsString = [lhsString stringByTrimmingCharactersInSet:whitespace];
                    
                    for (i = 0; i < count; i++)
                    {
                        rhsItem = [[rhsComponents objectAtIndex:i] stringByTrimmingCharactersInSet:whitespace];
                        if ([lhsString isEqualToString:rhsItem])
                        {
                            return YES;
                        }
                    }
                }
                return NO;
        }
    }
    else if (opType == OP_NUMBER)
    {
        lhsValue = [[self performSelector:selector] doubleValue];
        
        if (comparator == COMPARISON_ONEOF)
        {
            rhsComponents = [expandedRHS componentsSeparatedByString:@","];
            count = [rhsComponents count];
            
            for (i = 0; i < count; i++)
            {
                rhsItem = [rhsComponents objectAtIndex:i];
                rhsValue = [rhsItem doubleValue];
                
                if (lhsValue == rhsValue)
                {
                    return YES;
                }
            }
            
            return NO;
        }
        else
        {
            rhsValue = [expandedRHS doubleValue];
            
            switch (comparator)
            {
                case COMPARISON_EQUAL:
                    return lhsValue == rhsValue;
                    
                case COMPARISON_NOTEQUAL:
                    return lhsValue != rhsValue;
                    
                case COMPARISON_LESSTHAN:
                    return lhsValue < rhsValue;
                    
                case COMPARISON_GREATERTHAN:
                    return lhsValue > rhsValue;
                    
                case COMPARISON_UNDEFINED:
                case COMPARISON_ONEOF:
                    // "Can't happen" - undefined should have been caught by the sanitizer, oneof is handled above.
                    OOLog(@"script.error.unexpectedOperator", @"***** SCRIPT ERROR: in %@, operator %@ is not valid for numbers, evaluating to false.", CurrentScriptDesc(), OOComparisonTypeToString(comparator));
                    return NO;
            }
        }
    }
    else if (opType == OP_BOOL)
    {
        lhsFlag = [[self performSelector:selector] isEqualToString:@"YES"];
        rhsFlag = [expandedRHS isEqualToString:@"YES"];
        
        switch (comparator)
        {
            case COMPARISON_EQUAL:
                return lhsFlag == rhsFlag;
                
            case COMPARISON_NOTEQUAL:
                return lhsFlag != rhsFlag;
                
            case COMPARISON_LESSTHAN:
            case COMPARISON_GREATERTHAN:
            case COMPARISON_UNDEFINED:
            case COMPARISON_ONEOF:
                // "Can't happen" - should have been caught by the sanitizer.
                OOLog(@"script.error.unexpectedOperator", @"***** SCRIPT ERROR: in %@, operator %@ is not valid for booleans, evaluating to false.", CurrentScriptDesc(), OOComparisonTypeToString(comparator));
                return NO;
        }
    }
    
    // What are we doing here?
    OOLog(@"script.error.fallthrough", @"***** SCRIPT ERROR: in %@, unhandled condition '%@' (%@). %@", CurrentScriptDesc(), [scriptCondition objectAtIndex:1], scriptCondition, @"This is an internal error, please report it.");
    return NO;
}

scriptTestConditions:

- (BOOL) scriptTestConditions:

(NSArray *)

array

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                             :(NSArray *)array
{
    BOOL                result = NO;
    
    @try
    {
        result = TestScriptConditions(array);
    }
    @catch (NSException *exception)
    {
        OOLog(@"script.error.exception",
              @"***** EXCEPTION %@: %@ while testing legacy script conditions.",
              [exception name],
              [exception reason]);
        // Suppress exception
    }
    
    return result;
}

scriptTimer

- (OOTimeDelta) scriptTimer

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return script_time;
}

scriptTimer_number

- (NSNumber *) scriptTimer_number

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithDouble:[self scriptTimer]];
}

searchArrayForMatch:key:checkKeys:

- (NSString *) searchArrayForMatch: (NSArray *)  search_list key: (NSString *)  key checkKeys: (NSArray *)  check_keys

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                  :(NSArray *)search_list key:(NSString *)key checkKeys:(NSArray *)check_keys
{
    NSString *search = nil;
    NSUInteger i, j, k;
    for (i = 0; i < [search_list count]; i++)
    {
        search = (NSString*)[search_list objectAtIndex:i];
        // only check other key settings, not the one we've been passed
        if (![search isEqualToString:key])
        {
            // get the array from keyconfig2_settings
            // we need to compare all entries to each other to look for any match, as any match would indicate a conflict
            NSArray *current = nil;
            if (![self entryIsCustomEquip:search])
            {
                current = (NSArray *)[keyconfig2_settings objectForKey:search];
            }
            else 
            {
                NSUInteger idx = [self getCustomEquipIndex:search];
                NSString *keytype = [self getCustomEquipKeyDefType:search];
                current = (NSArray *)[[customEquipActivation objectAtIndex:idx] objectForKey:keytype];
            }
            for (j = 0; j < [current count]; j++) 
            {
                for (k = 0; k < [check_keys count]; k++)
                {
                    if ([self compareKeyEntries:[current objectAtIndex:j] second:[check_keys objectAtIndex:k]]) return search;
                }
            }
        }
    }
    return nil;
}

selectNextMissile

- (void) selectNextMissile

Definition at line 13727 of file PlayerEntity.m.

{
    if (![self weaponsOnline])  return;
    
    unsigned i;
    for (i = 1; i < max_missiles; i++)
    {
        int next_missile = (activeMissile + i) % max_missiles;
        if (missile_entity[next_missile])
        {
            // If we don't have the multi-targeting module installed, clear the active missiles' target
            if( ![self hasEquipmentItemProviding:@"EQ_MULTI_TARGET"] && [missile_entity[activeMissile] isMissile] )
            {
                [missile_entity[activeMissile] removeTarget:nil];
            }
 
            // Set next missile to active
            [self setActiveMissile:next_missile];
 
            if (missile_status != MISSILE_STATUS_SAFE)
            {
                missile_status = MISSILE_STATUS_ARMED;
 
                // If the newly active pylon contains a missile then work out its target, if any
                if( [missile_entity[activeMissile] isMissile] )
                {
                    if( [self hasEquipmentItemProviding:@"EQ_MULTI_TARGET"] &&
                            ([missile_entity[next_missile] primaryTarget] != nil))
                    {
                        // copy the missile's target
                        [self addTarget:[missile_entity[next_missile] primaryTarget]];
                        missile_status = MISSILE_STATUS_TARGET_LOCKED;
                    }
                    else if ([self primaryTarget] != nil)
                    {
                        // never inherit target if we have EQ_MULTI_TARGET installed! [ Bug #16221 : Targeting enhancement regression ]
                        /* CIM: seems okay to do this when launching a
                         * missile to stop multi-target being a bit
                         * irritating in a fight - 20/8/2014 */
                        if([self hasEquipmentItemProviding:@"EQ_MULTI_TARGET"] && !launchingMissile)
                        {
                            [self noteLostTarget];
                            DESTROY(_primaryTarget);
                        }
                        else
                        {
                            [missile_entity[activeMissile] addTarget:[self primaryTarget]];
                            missile_status = MISSILE_STATUS_TARGET_LOCKED;
                        }
                    }
                }
            }
            return;
        }
    }
}

selectNextMultiFunctionDisplay

- (void) selectNextMultiFunctionDisplay

Definition at line 13727 of file PlayerEntity.m.

{
    if ([[self hud] mfdCount] == 0) return;
    activeMFD = (activeMFD + 1) % [[self hud] mfdCount];
    NSUInteger mfdID = activeMFD + 1;
    [UNIVERSE addMessage:OOExpandKey(@"mfd-N-selected", mfdID) forCount:3.0 ];
    JSContext *context = OOJSAcquireContext();
    ShipScriptEvent(context, self, "selectedMFDChanged", INT_TO_JSVAL(activeMFD));
    OOJSRelinquishContext(context);
}

selectPreviousMultiFunctionDisplay

- (void) selectPreviousMultiFunctionDisplay

Definition at line 13727 of file PlayerEntity.m.

{
    if ([[self hud] mfdCount] == 0) return;
    if (activeMFD == 0) 
    {
        activeMFD = ([[self hud] mfdCount] - 1);
    }
    else
    {
        activeMFD = (activeMFD - 1);
    }
    NSUInteger mfdID = activeMFD + 1;
    [UNIVERSE addMessage:OOExpandKey(@"mfd-N-selected", mfdID) forCount:3.0 ];
    JSContext *context = OOJSAcquireContext();
    ShipScriptEvent(context, self, "selectedMFDChanged", INT_TO_JSVAL(activeMFD));
    OOJSRelinquishContext(context);
}

sendAllShipsAway

- (void) sendAllShipsAway

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    if (!UNIVERSE)
        return;
    int         ent_count =     UNIVERSE->n_entities;
    Entity**    uni_entities =  UNIVERSE->sortedEntities;   // grab the public sorted list
    Entity*     my_entities[ent_count];
    int i;
    for (i = 0; i < ent_count; i++)
        my_entities[i] = [uni_entities[i] retain];      //  retained
 
    for (i = 1; i < ent_count; i++)
    {
        Entity* e1 = my_entities[i];
        if ([e1 isShip])
        {
            ShipEntity* se1 = (ShipEntity*)e1;
            int e_class = [e1 scanClass];
            if (((e_class == CLASS_NEUTRAL)||(e_class == CLASS_POLICE)||(e_class == CLASS_MILITARY)||(e_class == CLASS_THARGOID)) &&
                                            ! ([se1 isStation] && [se1 maxFlightSpeed] == 0) &&  // exclude only stations, not carriers.
                                            [se1 hasHyperspaceMotor]) // exclude non jumping ships. Escorts will still be able to follow a mother.
            {
                AI* se1AI = [se1 getAI];
                [se1 setFuel:MAX(PLAYER_MAX_FUEL, [se1 fuelCapacity])];
                [se1 setAITo:@"exitingTraderAI.plist"]; // lets them return to their previous state after the jump
                [se1AI setState:@"EXIT_SYSTEM"];
                // The following should prevent all ships leaving at once (freezes oolite on slower machines)
                [se1AI setNextThinkTime:[UNIVERSE getTime] + 3 + (ranrot_rand() & 15)];
                [se1 setPrimaryRole:@"oolite-none"];    // prevents new ship from appearing at witchpoint when this one leaves!
            }
        }
    }
    
    for (i = 0; i < ent_count; i++)
    {
        [my_entities[i] release];       //  released
    }
}

Referenced by SystemSendAllShipsAway().

Here is the caller graph for this function:

sessionID

- (NSUInteger) sessionID

implementation

Reimplemented from Entity.

Definition at line 13727 of file PlayerEntity.m.

{
    // The player ship always belongs to the current session.
    return [UNIVERSE sessionID];
} 

set:

- (void) set:

(NSString *)

missionvariable_value

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

            :(NSString *)missionvariable_value
{
    NSMutableArray      *tokens = ScanTokensFromString(missionvariable_value);
    NSString            *missionVariableString = nil;
    NSString            *valueString = nil;
    BOOL                hasMissionPrefix, hasLocalPrefix;
 
    if ([tokens count] < 2)
    {
        OOLog(kOOLogSyntaxSet, @"***** SCRIPT ERROR: in %@, CANNOT SET '%@' (expected mission_variable or local_variable followed by value expression)", CurrentScriptDesc(), missionvariable_value);
        return;
    }
 
    missionVariableString = [tokens objectAtIndex:0];
    [tokens removeObjectAtIndex:0];
    valueString = [tokens componentsJoinedByString:@" "];
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
 
    if (!hasMissionPrefix && !hasLocalPrefix)
    {
        OOLog(kOOLogSyntaxSet, @"***** SCRIPT ERROR: in %@, IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString);
        return;
    }
 
    OOLog(kOOLogNoteSet, @"DEBUG: script %@ is set to %@", missionVariableString, valueString);
    
    if (hasMissionPrefix)
    {
        [self setMissionVariable:valueString forKey:missionVariableString];
    }
    else
    {
        [self setLocalVariable:valueString forKey:missionVariableString andMission:sCurrentMissionKey];
    }
}

setActiveMissile:

- (void) setActiveMissile:

(NSUInteger)

value

Definition at line 13727 of file PlayerEntity.m.

                         :(NSUInteger)value
{
    activeMissile = value;
}

setAftShieldLevel:

- (void) setAftShieldLevel:

(GLfloat)

level

Definition at line 13727 of file PlayerEntity.m.

                          :(GLfloat)level
{
    aft_shield = OOClamp_0_max_f(level, [self maxAftShieldLevel]);
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setAftShieldRechargeRate:

- (void) setAftShieldRechargeRate:

(float)

new

Definition at line 13727 of file PlayerEntity.m.

                                 :(float)new
{
    aft_shield_recharge_rate = new;
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setAlertFlag:to:

- (void) setAlertFlag:		(int)	flag
to:		(BOOL)	value

Definition at line 13727 of file PlayerEntity.m.

                     :(int)flag to:(BOOL)value
{
    if (value)
    {
        alertFlags |= flag;
    }
    else
    {
        int comp = ~flag;
        alertFlags &= comp;
    }
}

setBackgroundFromDescriptionsKey:

- (void) setBackgroundFromDescriptionsKey:

(NSString*)

d_key

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                                         :(NSString*) d_key
{
    NSArray * items = (NSArray *)[[UNIVERSE descriptions] objectForKey:d_key];
    //
    if (!items)
        return;
    //
    [self addScene: items atOffset: kZeroVector];
    //
    [self setShowDemoShips: YES];
}

setBounty:

- (void) setBounty: (OOCreditsQuantity)  amount

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                  :(OOCreditsQuantity) amount
{
    [self setBounty:amount withReason:kOOLegalStatusReasonUnknown];
}

setBounty:withReason:

- (void) setBounty: (OOCreditsQuantity)  amount withReason: (OOLegalStatusReason)  reason

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                  :(OOCreditsQuantity)amount withReason:(OOLegalStatusReason)reason
{
    NSString *nReason = OOStringFromLegalStatusReason(reason);
    [self setBounty:amount withReasonAsString:nReason];
}

Referenced by PlayerSetProperty().

Here is the caller graph for this function:

setBounty:withReasonAsString:

- (void) setBounty: (OOCreditsQuantity)  amount withReasonAsString: (NSString *)  reason

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                  :(OOCreditsQuantity)amount withReasonAsString:(NSString *)reason
{
    JSContext *context = OOJSAcquireContext();
    
    jsval amountVal = JSVAL_VOID;
    int amountVal2 = (int)amount-(int)legalStatus;
    JS_NewNumberValue(context, amountVal2, &amountVal);
 
    legalStatus = (int)amount; // can't set the new bounty until the size of the change is known
 
    jsval reasonVal = OOJSValueFromNativeObject(context,reason);
        
    ShipScriptEvent(context, self, "shipBountyChanged", amountVal, reasonVal);
        
    OOJSRelinquishContext(context);
}

setCargoQuantityForType:amount:

- (OOCargoQuantity) setCargoQuantityForType:		(OOCommodityType)	type
amount:		(OOCargoQuantity)	amount

Definition at line 9242 of file PlayerEntity.m.

                                           :(OOCommodityType)type amount:(OOCargoQuantity)amount
{
    OOMassUnit          unit = [shipCommodityData massUnitForGood:type];
    if([self specialCargo] && unit == UNITS_TONS) return 0; // don't do anything if we've got a special cargo...
    
    OOCargoQuantity     oldAmount = [self cargoQuantityForType:type];
    OOCargoQuantity     available = [self availableCargoSpace];
    BOOL                inPods = ([self status] != STATUS_DOCKED);
    
    // check it against the max amount.
    if (unit == UNITS_TONS && (available + oldAmount) < amount)
    {
        amount =  available + oldAmount;
    }
    // if we have 1499 kg the ship registers only 1 ton, so it's possible to exceed the max cargo:
    // eg: with maxAvailableCargoSpace 2 & gold 1499kg, you can still add 1 ton alloy. 
    else if (unit == UNITS_KILOGRAMS && amount > oldAmount)
    {
        // Allow up to 0.5 ton of kg (& g) goods above the cargo capacity but respect existing quantities.
        OOCargoQuantity     safeAmount = available * KILOGRAMS_PER_POD + MAX_KILOGRAMS_IN_SAFE;
        if (safeAmount < amount) amount = (safeAmount < oldAmount) ? oldAmount : safeAmount;
    }
    else if (unit == UNITS_GRAMS && amount > oldAmount)
    {
        OOCargoQuantity     safeAmount = available * GRAMS_PER_POD + MAX_GRAMS_IN_SAFE;
        if (safeAmount < amount) amount = (safeAmount < oldAmount) ? oldAmount : safeAmount;
    }
    
    if (inPods)
    {
        if (amount > oldAmount) // increase
        {
            [self loadCargoPodsForType:type amount:(amount - oldAmount)];
        }
        else
        {
            [self unloadCargoPodsForType:type amount:(oldAmount - amount)];
        }
    }
    else
    {
        [shipCommodityData setQuantity:amount forGood:type];
    }
 
    [self calculateCurrentCargo];
    return [shipCommodityData quantityForGood:type];
}

Referenced by ManifestSetProperty().

Here is the caller graph for this function:

setCommanderDataFromDictionary:

- (BOOL) setCommanderDataFromDictionary:

(NSDictionary *)

dict

Definition at line 13727 of file PlayerEntity.m.

                                      :(NSDictionary *) dict
{
    // multi-function displays
    // must be reset before ship setup
    [multiFunctionDisplayText release];
    multiFunctionDisplayText = [[NSMutableDictionary alloc] init];
 
    [multiFunctionDisplaySettings release];
    multiFunctionDisplaySettings = [[NSMutableArray alloc] init];
 
    [customDialSettings release];
    customDialSettings = [[NSMutableDictionary alloc] init];
 
    [[UNIVERSE gameView] resetTypedString];
 
    // Required keys
    if ([dict oo_stringForKey:@"ship_desc"] == nil)  return NO;
    // galaxy_seed is used is 1.80 or earlier
    if ([dict oo_stringForKey:@"galaxy_seed"] == nil && [dict oo_stringForKey:@"galaxy_id"] == nil)  return NO;
    // galaxy_coordinates is used is 1.80 or earlier
    if ([dict oo_stringForKey:@"galaxy_coordinates"] == nil && [dict oo_stringForKey:@"system_id"] == nil)  return NO;
    
    NSString *scenarioRestrict = [dict oo_stringForKey:@"scenario_restriction" defaultValue:nil];
    if (scenarioRestrict == nil)
    {
        // older save game - use the 'strict' key instead
        BOOL strict = [dict oo_boolForKey:@"strict" defaultValue:NO];
        if (strict)
        {
            scenarioRestrict = SCENARIO_OXP_DEFINITION_NONE;
        }
        else
        {
            scenarioRestrict = SCENARIO_OXP_DEFINITION_ALL;
        }
    }
 
    if (![UNIVERSE setUseAddOns:scenarioRestrict fromSaveGame:YES]) 
    {
        return NO;
    } 
 
    
    //base ship description
    [self setShipDataKey:[dict oo_stringForKey:@"ship_desc"]];
    
    NSDictionary *shipDict = [[OOShipRegistry sharedRegistry] shipInfoForKey:[self shipDataKey]];
    if (shipDict == nil)  return NO;
    if (![self setUpShipFromDictionary:shipDict])  return NO;
    OOLog(@"fuelPrices", @"Got \"%@\", fuel charge rate: %.2f", [self shipDataKey],[self fuelChargeRate]);
    
    // ship depreciation
    ship_trade_in_factor = [dict oo_intForKey:@"ship_trade_in_factor" defaultValue:95];
    
    // newer savegames use galaxy_id
    if ([dict oo_stringForKey:@"galaxy_id"] != nil)
    {
        galaxy_number = [dict oo_unsignedIntegerForKey:@"galaxy_id"];
        if (galaxy_number >= OO_GALAXIES_AVAILABLE)
        {
            return NO;
        }
        [UNIVERSE setGalaxyTo:galaxy_number andReinit:YES];
 
        system_id = [dict oo_intForKey:@"system_id"];
        if (system_id < 0 || system_id >= OO_SYSTEMS_PER_GALAXY)
        {
            return NO;
        }
 
        [UNIVERSE setSystemTo:system_id];
 
        NSArray *coord_vals = ScanTokensFromString([[UNIVERSE systemManager] getProperty:@"coordinates" forSystem:system_id inGalaxy:galaxy_number]);
        galaxy_coordinates.x = [coord_vals oo_unsignedCharAtIndex:0];
        galaxy_coordinates.y = [coord_vals oo_unsignedCharAtIndex:1];
        chart_centre_coordinates = galaxy_coordinates;
        target_chart_centre = chart_centre_coordinates;
        cursor_coordinates = galaxy_coordinates;
        chart_zoom = [dict oo_floatForKey:@"chart_zoom" defaultValue:1.0];
        target_chart_zoom = chart_zoom;
        saved_chart_zoom = chart_zoom;
        ANA_mode = [dict oo_intForKey:@"chart_ana_mode" defaultValue:OPTIMIZED_BY_NONE];
        longRangeChartMode = [dict oo_intForKey:@"chart_colour_mode" defaultValue:OOLRC_MODE_SUNCOLOR];
        if (longRangeChartMode == OOLRC_MODE_UNKNOWN) longRangeChartMode = OOLRC_MODE_SUNCOLOR;
 
        target_system_id = [dict oo_intForKey:@"target_id" defaultValue:system_id];
        previous_system_id = [dict oo_intForKey:@"previous_system_id" defaultValue:system_id];
        info_system_id = target_system_id;
        coord_vals = ScanTokensFromString([[UNIVERSE systemManager] getProperty:@"coordinates" forSystem:target_system_id inGalaxy:galaxy_number]);     
        cursor_coordinates.x = [coord_vals oo_unsignedCharAtIndex:0];
        cursor_coordinates.y = [coord_vals oo_unsignedCharAtIndex:1];
 
        chart_focus_coordinates = chart_centre_coordinates;
        target_chart_focus = chart_focus_coordinates;
 
        found_system_id = [dict oo_intForKey:@"found_system_id" defaultValue:-1];
    }
    else
        // compatibility for loading 1.80 savegames
    {
        galaxy_number = [dict oo_unsignedIntegerForKey:@"galaxy_number"];
 
        [UNIVERSE setGalaxyTo: galaxy_number andReinit:YES];
    
        NSArray *coord_vals = ScanTokensFromString([dict oo_stringForKey:@"galaxy_coordinates"]);
        galaxy_coordinates.x = [coord_vals oo_unsignedCharAtIndex:0];
        galaxy_coordinates.y = [coord_vals oo_unsignedCharAtIndex:1];
        chart_centre_coordinates = galaxy_coordinates;
        target_chart_centre = chart_centre_coordinates;
        cursor_coordinates = galaxy_coordinates;
        chart_zoom = 1.0;
        target_chart_zoom = 1.0;
        saved_chart_zoom = 1.0;
        ANA_mode = OPTIMIZED_BY_NONE;
        
        NSString *keyStringValue = [dict oo_stringForKey:@"target_coordinates"];
 
        if (keyStringValue != nil)
        {
            coord_vals = ScanTokensFromString(keyStringValue);
            cursor_coordinates.x = [coord_vals oo_unsignedCharAtIndex:0];
            cursor_coordinates.y = [coord_vals oo_unsignedCharAtIndex:1];
        }
        chart_focus_coordinates = chart_centre_coordinates;
        target_chart_focus = chart_focus_coordinates;
 
        // calculate system ID, target ID
        if ([dict objectForKey:@"current_system_name"])
        {
            system_id = [UNIVERSE findSystemFromName:[dict oo_stringForKey:@"current_system_name"]];
            if (system_id == -1)  system_id = [UNIVERSE findSystemNumberAtCoords:galaxy_coordinates withGalaxy:galaxy_number includingHidden:YES];
        }
        else
        {
            // really old save games don't have system name saved
            // use coordinates instead - unreliable in zero-distance pairs.
            system_id = [UNIVERSE findSystemNumberAtCoords:galaxy_coordinates withGalaxy:galaxy_number includingHidden:YES];
        }
        // and current_system_name and target_system_name
        // were introduced at different times, too
        if ([dict objectForKey:@"target_system_name"])
        {
            target_system_id = [UNIVERSE findSystemFromName:[dict oo_stringForKey:@"target_system_name"]];
            if (target_system_id == -1)  target_system_id = [UNIVERSE findSystemNumberAtCoords:cursor_coordinates withGalaxy:galaxy_number includingHidden:YES];
        }
        else
        {
            target_system_id = [UNIVERSE findSystemNumberAtCoords:cursor_coordinates withGalaxy:galaxy_number includingHidden:YES];
        }
        info_system_id = target_system_id;
        found_system_id = -1;
    }       
 
    NSString *cname = [dict oo_stringForKey:@"player_name" defaultValue:PLAYER_DEFAULT_NAME];
    [self setCommanderName:cname];
    [self setLastsaveName:[dict oo_stringForKey:@"player_save_name" defaultValue:cname]];
 
    [self setShipUniqueName:[dict oo_stringForKey:@"ship_unique_name" defaultValue:@""]];
    [self setShipClassName:[dict oo_stringForKey:@"ship_class_name" defaultValue:[shipDict oo_stringForKey:@"name"]]];
    
    [shipCommodityData loadPlayerAmounts:[dict oo_arrayForKey:@"shipCommodityData"]];
    
    // extra equipment flags
    [self removeAllEquipment];
    NSMutableDictionary *equipment = [NSMutableDictionary dictionaryWithDictionary:[dict oo_dictionaryForKey:@"extra_equipment"]];
    
    // Equipment flags  (deprecated in favour of equipment dictionary, keep for compatibility)
    if ([dict oo_boolForKey:@"has_docking_computer"])       [equipment oo_setInteger:1 forKey:@"EQ_DOCK_COMP"];
    if ([dict oo_boolForKey:@"has_galactic_hyperdrive"])    [equipment oo_setInteger:1 forKey:@"EQ_GAL_DRIVE"];
    if ([dict oo_boolForKey:@"has_escape_pod"])             [equipment oo_setInteger:1 forKey:@"EQ_ESCAPE_POD"];
    if ([dict oo_boolForKey:@"has_ecm"])                    [equipment oo_setInteger:1 forKey:@"EQ_ECM"];
    if ([dict oo_boolForKey:@"has_scoop"])                  [equipment oo_setInteger:1 forKey:@"EQ_FUEL_SCOOPS"];
    if ([dict oo_boolForKey:@"has_energy_bomb"])            [equipment oo_setInteger:1 forKey:@"EQ_ENERGY_BOMB"];
    if ([dict oo_boolForKey:@"has_fuel_injection"])     [equipment oo_setInteger:1 forKey:@"EQ_FUEL_INJECTION"];
    
    
    // Legacy energy unit type -> energy unit equipment item
    if ([dict oo_boolForKey:@"has_energy_unit"] && [self installedEnergyUnitType] == ENERGY_UNIT_NONE)
    {
        OOEnergyUnitType eType = [dict oo_intForKey:@"energy_unit" defaultValue:ENERGY_UNIT_NORMAL];
        switch (eType)
        {
            // look for NEU first!
            case OLD_ENERGY_UNIT_NAVAL:
                [equipment oo_setInteger:1 forKey:@"EQ_NAVAL_ENERGY_UNIT"];
                break;
            
            case OLD_ENERGY_UNIT_NORMAL:
                [equipment oo_setInteger:1 forKey:@"EQ_ENERGY_UNIT"];
                break;
 
            default:
                break;
        }
    }
    
    custom_chart_zoom = 1.0;
    custom_chart_centre_coordinates = NSMakePoint(galaxy_coordinates.y, galaxy_coordinates.y);
 
    /*  Energy bombs are no longer supported without OXPs. As compensation,
        we'll award either a Q-mine or some cash. We can't determine what to
        award until we've handled missiles later on, though.
    */
    BOOL energyBombCompensation = NO;
    if ([equipment oo_boolForKey:@"EQ_ENERGY_BOMB"] && [OOEquipmentType equipmentTypeWithIdentifier:@"EQ_ENERGY_BOMB"] == nil)
    {
        energyBombCompensation = YES;
        [equipment removeObjectForKey:@"EQ_ENERGY_BOMB"];
    }
    
    eqScripts = [[NSMutableArray alloc] init];
    [self addEquipmentFromCollection:equipment];
    primedEquipment = [self eqScriptIndexForKey:[dict oo_stringForKey:@"primed_equipment"]];    // if key not found primedEquipment is set to primed-none
    
    [self setFastEquipmentA:[dict oo_stringForKey:@"primed_equipment_a" defaultValue:@"EQ_CLOAKING_DEVICE"]];
    [self setFastEquipmentB:[dict oo_stringForKey:@"primed_equipment_b" defaultValue:@"EQ_ENERGY_BOMB"]]; // even though there isn't one, for compatibility.
 
    if ([self hasEquipmentItemProviding:@"EQ_ADVANCED_COMPASS"])  compassMode = COMPASS_MODE_PLANET;
    else  compassMode = COMPASS_MODE_BASIC;
    DESTROY(compassTarget);
    
    // speech
    isSpeechOn = [dict oo_intForKey:@"speech_on"];
#if OOLITE_ESPEAK
    voice_gender_m = [dict oo_boolForKey:@"speech_gender" defaultValue:YES];
    voice_no = [UNIVERSE setVoice:[UNIVERSE voiceNumber:[dict oo_stringForKey:@"speech_voice" defaultValue:nil]] withGenderM:voice_gender_m];
#endif
    
    // reputation
    [reputation release];
    reputation = [[dict oo_dictionaryForKey:@"reputation"] mutableCopy];
    if (reputation == nil)  reputation = [[NSMutableDictionary alloc] init];
    [self normaliseReputation];
 
    // passengers and contracts
    [parcels release];
    [parcel_record release];
    [passengers release];
    [passenger_record release];
    [contracts release];
    [contract_record release];
    
    max_passengers = [dict oo_intForKey:@"max_passengers" defaultValue:0];
    passengers = [[dict oo_arrayForKey:@"passengers"] mutableCopy];
    passenger_record = [[dict oo_dictionaryForKey:@"passenger_record"] mutableCopy];
    /* Note: contracts from older savegames will have ints in the commodity.
     * Need to fix this up */
    contracts = [[dict oo_arrayForKey:@"contracts"] mutableCopy];
    NSMutableDictionary *contractInfo = nil;
 
    // iterate downwards; lets us remove invalid ones as we go
    for (NSInteger i = (NSInteger)[contracts count] - 1; i >= 0; i--)
    {
        contractInfo = [[[contracts oo_dictionaryAtIndex:i] mutableCopy] autorelease];
        // if the trade good ID is an int
        if ([[contractInfo objectForKey:CARGO_KEY_TYPE] isKindOfClass:[NSNumber class]])
        {
            // look it up, and replace with a string
            NSUInteger legacy_type = [contractInfo oo_unsignedIntegerForKey:CARGO_KEY_TYPE];
            [contractInfo setObject:[OOCommodities legacyCommodityType:legacy_type] forKey:CARGO_KEY_TYPE];
            [contracts replaceObjectAtIndex:i withObject:[[contractInfo copy] autorelease]];
        }
        else
        {
            OOCommodityType new_type = [contractInfo oo_stringForKey:CARGO_KEY_TYPE];
            // check that that the type still exists
            if (![[UNIVERSE commodities] goodDefined:new_type])
            {
                OOLog(@"setCommanderDataFromDictionary.warning.contract",@"Cargo contract to deliver %@ could not be loaded from the saved game, as the commodity is no longer defined",new_type);
                [contracts removeObjectAtIndex:i];
            }
        }
    }
 
    contract_record = [[dict oo_dictionaryForKey:@"contract_record"] mutableCopy];
    parcels = [[dict oo_arrayForKey:@"parcels"] mutableCopy];
    parcel_record = [[dict oo_dictionaryForKey:@"parcel_record"] mutableCopy];
 
    
    
    if (passengers == nil)  passengers = [[NSMutableArray alloc] init];
    if (passenger_record == nil)  passenger_record = [[NSMutableDictionary alloc] init];
    if (contracts == nil)  contracts = [[NSMutableArray alloc] init];
    if (contract_record == nil)  contract_record = [[NSMutableDictionary alloc] init];
    if (parcels == nil)  parcels = [[NSMutableArray alloc] init];
    if (parcel_record == nil)  parcel_record = [[NSMutableDictionary alloc] init];
    
    //specialCargo
    [specialCargo release];
    specialCargo = [[dict oo_stringForKey:@"special_cargo"] copy];
    
    // mission destinations
    NSArray *legacyDestinations = [dict oo_arrayForKey:@"missionDestinations"];
 
    NSDictionary *newDestinations = [dict oo_dictionaryForKey:@"mission_destinations"];
    [self initialiseMissionDestinations:newDestinations andLegacy:legacyDestinations];
    
    // shipyard
    DESTROY(shipyard_record);
    shipyard_record = [[dict oo_dictionaryForKey:@"shipyard_record"] mutableCopy];
    if (shipyard_record == nil)  shipyard_record = [[NSMutableDictionary alloc] init];
    
    // Normalize cargo capacity
    unsigned    original_hold_size = [UNIVERSE maxCargoForShip:[self shipDataKey]];
    // Not Suitable For Oolite
    //unsigned  passenger_space = [[OOEquipmentType equipmentTypeWithIdentifier:@"EQ_PASSENGER_BERTH"] requiredCargoSpace];
    //if (passenger_space == 0) passenger_space = PASSENGER_BERTH_SPACE;
    
    max_cargo = [dict oo_unsignedIntForKey:@"max_cargo" defaultValue:max_cargo];
    if (max_cargo > original_hold_size)  [self addEquipmentItem:@"EQ_CARGO_BAY" inContext:@"loading"];
    max_cargo = original_hold_size + ([self hasExpandedCargoBay] ? extra_cargo : 0);
    if (max_cargo < max_passengers * PASSENGER_BERTH_SPACE)
    {
        // Something went wrong. Possibly the save file was hacked to contain more passenger cabins than the available cargo space would allow - Nikos 20110731
        unsigned originalMaxPassengers = max_passengers;
        max_passengers = (unsigned)(max_cargo / PASSENGER_BERTH_SPACE);
        OOLogWARN(@"setCommanderDataFromDictionary.inconsistency.max_passengers", @"player ship %@ had max_passengers set to a value requiring more cargo space than currently available (%u). Setting max_passengers to maximum possible value (%u).", [self name], originalMaxPassengers, max_passengers);
    }
    max_cargo -= max_passengers * PASSENGER_BERTH_SPACE;
    
    // Do we have extra passengers?
    if (passengers && ([passengers count] > max_passengers))
    {
        OOLogWARN(@"setCommanderDataFromDictionary.inconsistency.passengers", @"player ship %@ had more passengers (%llu) than passenger berths (%u). Removing extra passengers.", [self name], [passengers count], max_passengers);
        for (NSInteger i = (NSInteger)[passengers count] - 1; i >= max_passengers; i--)
        {
            [passenger_record removeObjectForKey:[[passengers oo_dictionaryAtIndex:i] oo_stringForKey:PASSENGER_KEY_NAME]];
            [passengers removeObjectAtIndex:i];
        }
    }
    
    // too much cargo?  
    NSInteger excessCargo = (NSInteger)[self cargoQuantityOnBoard] - (NSInteger)[self maxAvailableCargoSpace];
    if (excessCargo > 0)
    {
        OOLogWARN(@"setCommanderDataFromDictionary.inconsistency.cargo", @"player ship %@ had more cargo (%i) than it can hold (%u). Removing extra cargo.", [self name], [self cargoQuantityOnBoard], [self maxAvailableCargoSpace]);
        
        OOCommodityType     type;
        OOMassUnit          units;
        OOCargoQuantity     oldAmount, toRemove;
        
        OOCargoQuantity remainingExcess = (OOCargoQuantity)excessCargo;
        
        // manifest always contains entries for all 17 commodities, even if their quantity is 0.
        foreach (type, [shipCommodityData goods])
        {
            units = [shipCommodityData massUnitForGood:type];
 
            oldAmount = [shipCommodityData quantityForGood:type];
            BOOL roundedTon = (units != UNITS_TONS) && ((units == UNITS_KILOGRAMS && oldAmount > MAX_KILOGRAMS_IN_SAFE) || (units == UNITS_GRAMS && oldAmount > MAX_GRAMS_IN_SAFE));
            if (roundedTon || (units == UNITS_TONS && oldAmount > 0))
            {
                // let's remove stuff
                OOCargoQuantity partAmount = oldAmount;
                toRemove = 0;
                while (remainingExcess > 0 && partAmount > 0)
                {
                    if (EXPECT_NOT(roundedTon && ((units == UNITS_KILOGRAMS && partAmount > MAX_KILOGRAMS_IN_SAFE) || (units == UNITS_GRAMS && partAmount > MAX_GRAMS_IN_SAFE))))
                    {
                        toRemove += (units == UNITS_KILOGRAMS) ? (partAmount > (KILOGRAMS_PER_POD + MAX_KILOGRAMS_IN_SAFE) ? KILOGRAMS_PER_POD : partAmount - MAX_KILOGRAMS_IN_SAFE)
                                    : (partAmount > (GRAMS_PER_POD + MAX_GRAMS_IN_SAFE) ? GRAMS_PER_POD : partAmount - MAX_GRAMS_IN_SAFE);
                        partAmount = oldAmount - toRemove;
                        remainingExcess--;
                    }
                    else if (!roundedTon)
                    {
                        toRemove++;
                        partAmount--;
                        remainingExcess--;
                    }
                    else
                    {
                        partAmount = 0;
                    }
                }
                [shipCommodityData removeQuantity:toRemove forGood:type];
            }
        }
    }
    
    credits = OODeciCreditsFromObject([dict objectForKey:@"credits"]);
    
    fuel = [dict oo_unsignedIntForKey:@"fuel" defaultValue:fuel];
    galaxy_number = [dict oo_intForKey:@"galaxy_number"];
//
    NSDictionary *shipyard_info = [[OOShipRegistry sharedRegistry] shipyardInfoForKey:[self shipDataKey]];
    OOWeaponFacingSet available_facings = [shipyard_info oo_unsignedIntForKey:KEY_WEAPON_FACINGS defaultValue:[self weaponFacings]];
 
    if (available_facings & WEAPON_FACING_FORWARD)
        forward_weapon_type = OOWeaponTypeFromEquipmentIdentifierLegacy([dict oo_stringForKey:@"forward_weapon"]);
    else
        forward_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy(@"EQ_WEAPON_NONE");
 
    if (available_facings & WEAPON_FACING_AFT)
        aft_weapon_type = OOWeaponTypeFromEquipmentIdentifierLegacy([dict oo_stringForKey:@"aft_weapon"]);
    else
        aft_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy(@"EQ_WEAPON_NONE");
 
    if (available_facings & WEAPON_FACING_PORT)
        port_weapon_type = OOWeaponTypeFromEquipmentIdentifierLegacy([dict oo_stringForKey:@"port_weapon"]);
    else
        port_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy(@"EQ_WEAPON_NONE");
 
    if (available_facings & WEAPON_FACING_STARBOARD)
        starboard_weapon_type = OOWeaponTypeFromEquipmentIdentifierLegacy([dict oo_stringForKey:@"starboard_weapon"]);
    else
        starboard_weapon_type = OOWeaponTypeFromEquipmentIdentifierSloppy(@"EQ_WEAPON_NONE");
 
    [self setWeaponDataFromType:forward_weapon_type];
 
    if (hud != nil && [hud nonlinearScanner])
    {
        [hud setScannerZoom: [dict oo_floatForKey:@"ship_scanner_zoom" defaultValue: 1.0]];
    }
    
    weapons_online = [dict oo_boolForKey:@"weapons_online" defaultValue:YES];
    
    legalStatus = [dict oo_intForKey:@"legal_status"];
    market_rnd = [dict oo_intForKey:@"market_rnd"];
    ship_kills = [dict oo_intForKey:@"ship_kills"];
    
    ship_clock = [dict oo_doubleForKey:@"ship_clock" defaultValue:PLAYER_SHIP_CLOCK_START];
    fps_check_time = ship_clock;
    
    escape_pod_rescue_time = [dict oo_doubleForKey:@"escape_pod_rescue_time" defaultValue:0.0];
    
    // role weights
    [roleWeights release];
    roleWeights = [[dict oo_arrayForKey:@"role_weights"] mutableCopy];
    NSUInteger rc = [self maxPlayerRoles];
    if (roleWeights == nil)
    {
        roleWeights = [[NSMutableArray alloc] initWithCapacity:rc];
        while (rc-- > 0)
        {
            [roleWeights addObject:@"player-unknown"];
        }
    }
    else
    {
        if ([roleWeights count] > rc)
        {
            [roleWeights removeObjectsInRange:(NSRange) {rc,[roleWeights count]-rc}];
        }
    }
 
    roleWeightFlags = [[dict oo_dictionaryForKey:@"role_weight_flags"] mutableCopy];
    if (roleWeightFlags == nil)
    {
        roleWeightFlags = [[NSMutableDictionary alloc] init];
    }
 
    roleSystemList = [[dict oo_arrayForKey:@"role_system_memory"] mutableCopy];
    if (roleSystemList == nil)
    {
        roleSystemList = [[NSMutableArray alloc] initWithCapacity:32];
    }
 
 
    // mission_variables
    [mission_variables release];
    mission_variables = [[dict oo_dictionaryForKey:@"mission_variables"] mutableCopy];
    if (mission_variables == nil)  mission_variables = [[NSMutableDictionary alloc] init];
    
    // persistant UNIVERSE info
    NSDictionary *planetInfoOverrides = [dict oo_dictionaryForKey:@"scripted_planetinfo_overrides"];
    if (planetInfoOverrides != nil)
    {
        [[UNIVERSE systemManager] importScriptedChanges:planetInfoOverrides];   
    } 
    else
    {
        // no scripted overrides? What about 1.80-style local overrides?
        planetInfoOverrides = [dict oo_dictionaryForKey:@"local_planetinfo_overrides"];
        if (planetInfoOverrides != nil)
        {
            [[UNIVERSE systemManager] importLegacyScriptedChanges:planetInfoOverrides];
        }
    }
    
    // communications log
    [commLog release];
    commLog = [[NSMutableArray alloc] initWithCapacity:kCommLogTrimThreshold];
    
    NSArray *savedCommLog = [dict oo_arrayForKey:@"comm_log"];
    NSUInteger commCount = [savedCommLog count];
    for (NSUInteger i = 0; i < commCount; i++)
    {
        [UNIVERSE addCommsMessage:[savedCommLog objectAtIndex:i] forCount:0 andShowComms:NO logOnly:YES];
    }
 
    /*  entity_personality for scripts and shaders. If undefined, we fall back
        to old behaviour of using a random value each time game is loaded (set
        up in -setUp). Saving of entity_personality was added in 1.74.
        -- Ahruman 2009-09-13
    */
    entity_personality = [dict oo_unsignedShortForKey:@"entity_personality" defaultValue:entity_personality];
    
    // set up missiles
    [self setActiveMissile:0];
    for (NSUInteger i = 0; i < PLAYER_MAX_MISSILES; i++)
    {
        [missile_entity[i] release];
        missile_entity[i] = nil;
    }
    NSArray *missileRoles = [dict oo_arrayForKey:@"missile_roles"];
    if (missileRoles != nil)
    {
        unsigned missileCount = 0;
        for (NSUInteger roleIndex = 0; roleIndex < [missileRoles count] && missileCount < max_missiles; roleIndex++)
        {
            NSString *missile_desc = [missileRoles oo_stringAtIndex:roleIndex];
            if (missile_desc != nil && ![missile_desc isEqualToString:@"NONE"])
            {
                ShipEntity *amiss = [UNIVERSE newShipWithRole:missile_desc];
                if (amiss)
                {
                    missile_list[missileCount] = [OOEquipmentType equipmentTypeWithIdentifier:missile_desc];
                    missile_entity[missileCount] = amiss;   // retain count = 1
                    missileCount++;
                }
                else
                {
                    OOLogWARN(@"load.failed.missileNotFound", @"couldn't find missile with role '%@' in [PlayerEntity setCommanderDataFromDictionary:], missile entry discarded.", missile_desc);
                }
            }
            missiles = missileCount;
        }
    }
    else    // no missile_roles
    {
        for (NSUInteger i = 0; i < missiles; i++)
        {
            missile_list[i] = [OOEquipmentType equipmentTypeWithIdentifier:@"EQ_MISSILE"];
            missile_entity[i] = [UNIVERSE newShipWithRole:@"EQ_MISSILE"];   // retain count = 1 - should be okay as long as we keep a missile with this role
                                                                            // in the base package.
        }
    }
    
    if (energyBombCompensation)
    {
        /*
            Compensate energy bomb with either a QC mine or the cost of an
            energy bomb (900 credits). This must be done after missiles are
            set up.
        */
        if ([self mountMissileWithRole:@"EQ_QC_MINE"])
        {
            OOLog(@"load.upgrade.replacedEnergyBomb", @"%@", @"Replaced legacy energy bomb with Quirium cascade mine.");
        }
        else
        {
            credits += 9000;
            OOLog(@"load.upgrade.replacedEnergyBomb", @"%@", @"Compensated legacy energy bomb with 900 credits.");
        }
    }
    
    [self setActiveMissile:0];
    
    [self setHeatInsulation:1.0];
 
    max_forward_shield              = BASELINE_SHIELD_LEVEL;
    max_aft_shield                  = BASELINE_SHIELD_LEVEL;
 
    forward_shield_recharge_rate    = 2.0;
    aft_shield_recharge_rate        = 2.0;
 
    forward_shield = [self maxForwardShieldLevel];
    aft_shield = [self maxAftShieldLevel];
    
    // used to get current_system and target_system here,
    // but stores the ID in the save file instead
    
    // restore subentities status
    [self deserializeShipSubEntitiesFrom:[dict oo_stringForKey:@"subentities_status"]];
    
    // wormholes
    NSArray * whArray;
    whArray = [dict objectForKey:@"wormholes"];
    NSDictionary * whCurrDict;
    [scannedWormholes release];
    scannedWormholes = [[NSMutableArray alloc] initWithCapacity:[whArray count]];
    foreach (whCurrDict, whArray)
    {
        WormholeEntity * wh = [[WormholeEntity alloc] initWithDict:whCurrDict];
        [scannedWormholes addObject:wh];
        /* TODO - add to Universe if the wormhole hasn't expired yet; but in this case
         * we need to save/load position and mass as well, which we currently 
         * don't
        if (equal_seeds([wh origin], system_seed))
        {
            [UNIVERSE addEntity:wh];
        }
        */
    }
    
    // custom view no.
    if (_customViews != nil)
        _customViewIndex = [dict oo_unsignedIntForKey:@"custom_view_index"] % [_customViews count];
 
 
    // docking clearance protocol
    [UNIVERSE setDockingClearanceProtocolActive:[dict oo_boolForKey:@"docking_clearance_protocol" defaultValue:NO]];
    
    // trumble information
    [self setUpTrumbles];
    [self setTrumbleValueFrom:[dict objectForKey:@"trumbles"]]; // if it doesn't exist we'll check user-defaults
 
    return YES;
}

setCommanderName:

- (void) setCommanderName:

(NSString *)

value

Definition at line 9242 of file PlayerEntity.m.

                         :(NSString *)value
{
    NSParameterAssert(value != nil);
    [_commanderName autorelease];
    _commanderName = [value copy];
}

Referenced by PlayerSetProperty().

Here is the caller graph for this function:

setCompassMode:

- (void) setCompassMode:

(OOCompassMode)

value

Definition at line 13727 of file PlayerEntity.m.

                       :(OOCompassMode) value
{
    compassMode = value;
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setCompassTarget:

- (void) setCompassTarget:

(Entity *)

value

Definition at line 13727 of file PlayerEntity.m.

                         :(Entity *)value
{
    [compassTarget release];
    compassTarget = [value weakRetain];
}

setCreditBalance:

- (void) setCreditBalance:

(double)

value

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                         :(double)value
{
    credits = OODeciCreditsFromDouble(value * 10.0);
}

Referenced by PlayerSetProperty().

Here is the caller graph for this function:

setCustomChartCentre:

- (void) setCustomChartCentre:

(NSPoint)

coords

Definition at line 13727 of file PlayerEntity.m.

                             :(NSPoint)coords
{
    custom_chart_centre_coordinates.x = coords.x;
    custom_chart_centre_coordinates.y = coords.y;
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setCustomChartZoom:

- (void) setCustomChartZoom:

(OOScalar)

zoom

Definition at line 13727 of file PlayerEntity.m.

                           :(OOScalar)zoom
{
    custom_chart_zoom = zoom;
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setCustomViewData

- (void) setCustomViewData

Definition at line 9242 of file PlayerEntity.m.

{
    customViewRightVector = vector_right_from_quaternion(customViewQuaternion);
    customViewUpVector = vector_up_from_quaternion(customViewQuaternion);
    customViewForwardVector = vector_forward_from_quaternion(customViewQuaternion);
    
    Quaternion q1 = customViewQuaternion;
    q1.w = -q1.w;
    customViewMatrix = OOMatrixForQuaternionRotation(q1);
}

setCustomViewDataFromDictionary:withScaling:

- (void) setCustomViewDataFromDictionary:		(NSDictionary*)	viewDict
withScaling:		(BOOL)	withScaling

Definition at line 9242 of file PlayerEntity.m.

                                        :(NSDictionary *)viewDict withScaling:(BOOL)withScaling
{
    customViewMatrix = kIdentityMatrix;
    customViewOffset = kZeroVector;
    if (viewDict == nil)  return;
    
    customViewQuaternion = [viewDict oo_quaternionForKey:@"view_orientation"];
    [self setCustomViewData];
    
    // easier to do the multiplication at this point than at load time
    if (withScaling)
    {
        customViewOffset = vector_multiply_scalar([viewDict oo_vectorForKey:@"view_position"],_scaleFactor);
    }
    else
    {
        // but don't do this when the custom view is set through JS
        customViewOffset = [viewDict oo_vectorForKey:@"view_position"];
    }
    customViewRotationCenter = vector_subtract(customViewOffset, vector_multiply_scalar(customViewForwardVector, dot_product(customViewOffset, customViewForwardVector)));
    customViewDescription = [viewDict oo_stringForKey:@"view_description"];
    
    NSString *facing = [[viewDict oo_stringForKey:@"weapon_facing"] lowercaseString];
    if ([facing isEqual:@"aft"])
    {
        currentWeaponFacing = WEAPON_FACING_AFT;
    }
    else if ([facing isEqual:@"port"])
    {
        currentWeaponFacing = WEAPON_FACING_PORT;
    }
    else if ([facing isEqual:@"starboard"])
    {
        currentWeaponFacing = WEAPON_FACING_STARBOARD;
    }
    else if ([facing isEqual:@"forward"])
    {
        currentWeaponFacing = WEAPON_FACING_FORWARD;
    }
    // if the weapon facing is unset / unknown, 
    // don't change current weapon facing!
}

Referenced by PlayerShipSetCustomView().

Here is the caller graph for this function:

setCustomViewOffset:

- (void) setCustomViewOffset:

(Vector)

offset

Definition at line 9242 of file PlayerEntity.m.

                            :(Vector) offset
{
    customViewOffset = offset;
}

setCustomViewQuaternion:

- (void) setCustomViewQuaternion:

(Quaternion)

q1

Definition at line 9242 of file PlayerEntity.m.

                                :(Quaternion)q
{
    customViewQuaternion = q;
    [self setCustomViewData];
}

setCustomViewRotationCenter:

- (void) setCustomViewRotationCenter:

(Vector)

center

Definition at line 9242 of file PlayerEntity.m.

                                    :(Vector) center
{
    customViewRotationCenter = center;
}

setDefaultCustomViews

- (void) setDefaultCustomViews

Definition at line 9242 of file PlayerEntity.m.

{
    NSArray *customViews = [[[OOShipRegistry sharedRegistry] shipInfoForKey:PLAYER_SHIP_DESC] oo_arrayForKey:@"custom_views"];
    
    [_customViews release];
    _customViews = nil;
    _customViewIndex = 0;
    if (customViews != nil)
    {
        _customViews = [customViews retain];
    }
}

setDefaultViewOffsets

- (void) setDefaultViewOffsets

Definition at line 9242 of file PlayerEntity.m.

{
    float halfLength = 0.5f * (boundingBox.max.z - boundingBox.min.z);
    float halfWidth = 0.5f * (boundingBox.max.x - boundingBox.min.x);
 
    forwardViewOffset = make_vector(0.0f, 0.0f, boundingBox.max.z - halfLength);
    aftViewOffset = make_vector(0.0f, 0.0f, boundingBox.min.z + halfLength);
    portViewOffset = make_vector(boundingBox.min.x + halfWidth, 0.0f, 0.0f);
    starboardViewOffset = make_vector(boundingBox.max.x - halfWidth, 0.0f, 0.0f);
    customViewOffset = kZeroVector;
}

setDialCustom:forKey:

- (void) setDialCustom:		(id)	value
forKey:		(NSString *)	key

Definition at line 13727 of file PlayerEntity.m.

                      :(id)value forKey:(NSString *)dialKey
{
    [customDialSettings setObject:value forKey:dialKey];
}

Referenced by PlayerShipSetCustomHUDDial().

Here is the caller graph for this function:

setDialIdentEngaged:

- (void) setDialIdentEngaged:

(BOOL)

newValue

Definition at line 13727 of file PlayerEntity.m.

                            :(BOOL)newValue
{
    ident_engaged = !!newValue;
}

setDockedAtMainStation

- (void) setDockedAtMainStation

Definition at line 13727 of file PlayerEntity.m.

{
    [self setDockedStation:[UNIVERSE station]];
    if (_dockedStation != nil)  [self setStatus:STATUS_DOCKED];
}

setDockedStation:

- (void) setDockedStation:

(StationEntity *)

station

Definition at line 13727 of file PlayerEntity.m.

                         :(StationEntity *)station
{
    [_dockedStation release];
    _dockedStation = [station weakRetain];
}

setDockingClearanceStatus:

- (void) setDockingClearanceStatus:

(OODockingClearanceStatus)

newValue

Definition at line 9242 of file PlayerEntity.m.

                                 :(OODockingClearanceStatus)newValue
{
    dockingClearanceStatus = newValue;
    if (dockingClearanceStatus == DOCKING_CLEARANCE_STATUS_NONE)
    {
        targetDockStation = nil;
    }
    else if (dockingClearanceStatus == DOCKING_CLEARANCE_STATUS_REQUESTED || dockingClearanceStatus == DOCKING_CLEARANCE_STATUS_NOT_REQUIRED)
    {
        if ([[self primaryTarget] isStation])
        {
            targetDockStation = [self primaryTarget];
        }
        else
        {
            OOLog(@"player.badDockingTarget", @"Attempt to dock at %@.", [self primaryTarget]);
            targetDockStation = nil;
            dockingClearanceStatus = DOCKING_CLEARANCE_STATUS_NONE;
        }
    }
}

Referenced by StationDockPlayer().

Here is the caller graph for this function:

setDockTarget:

- (void) setDockTarget:

(ShipEntity *)

entity

Definition at line 9242 of file PlayerEntity.m.

                      :(ShipEntity *)entity
{
if ([entity isStation]) _dockTarget = [entity universalID];
else _dockTarget = NO_TARGET;
    //_dockTarget = [entity isStation] ? [entity universalID]: NO_TARGET;
}

Referenced by PlayerSetEscapePodDestination().

Here is the caller graph for this function:

setEquipScreenBackgroundDescriptor:

- (void) setEquipScreenBackgroundDescriptor:

(NSDictionary *)

descriptor

Definition at line 9242 of file PlayerEntity.m.

                                           :(NSDictionary *)descriptor
{
    if (descriptor != _equipScreenBackgroundDescriptor)
    {
        [_equipScreenBackgroundDescriptor autorelease];
        _equipScreenBackgroundDescriptor = [descriptor copy];
    }
}

setEscapePodRescueTime:

- (void) setEscapePodRescueTime:

(double)

seconds

Definition at line 13727 of file PlayerEntity.m.

                               :(double)seconds
{
    escape_pod_rescue_time = seconds;
}

Referenced by PlayerSetProperty().

Here is the caller graph for this function:

setExtraEquipmentFromFlags

- (void) setExtraEquipmentFromFlags

implementation

Provided by category PlayerEntity(OOPrivate).

setExtraGuiScreenKeys:definition:

- (BOOL) setExtraGuiScreenKeys:		(OOGUIScreenID)	gui
definition:		(OOJSGuiScreenKeyDefinition *)	definition

create the dictionary, if it doesn't already exist

Definition at line 9242 of file PlayerEntity.m.

                              :(OOGUIScreenID)gui definition:(OOJSGuiScreenKeyDefinition *)definition
{
    // process all the keys in the definition
    BOOL result = YES;
    NSMutableArray *newarray = nil;
    NSString *key = nil;    
    NSMutableDictionary *final = [[NSMutableDictionary alloc] init];
    NSDictionary *keys = [definition registerKeys];
    NSMutableArray *checklist = [[NSMutableArray alloc] init];
 
    foreach (key, [keys allKeys])
    {
        NSArray *item = [self processKeyCode:[keys oo_arrayForKey:key]];
        [checklist addObject:item];
        [final setObject:item forKey:key];
    }
    [definition setRegisterKeys:[final copy]];
    [final release];
 
    if (!extraGuiScreenKeys) 
    {
        extraGuiScreenKeys = [[NSMutableDictionary alloc] init];
    }
 
    if (![extraGuiScreenKeys objectForKey:[NSString stringWithFormat:@"%d",gui]]) 
    {
        // brand new - just add
        newarray = [[NSMutableArray alloc] init];
    }
    else 
    {
        newarray = [[extraGuiScreenKeys objectForKey:[NSString stringWithFormat:@"%d",gui]] mutableCopy];
        NSInteger i = [newarray count];
        NSInteger j = 0;
        OOJSGuiScreenKeyDefinition *def_existing = nil;
        while (i--) 
        {
            def_existing = [newarray objectAtIndex:i]; 
            // if we find this name already in the array, remove it
            if (def_existing && [[def_existing name] isEqualToString:[definition name]])
            {
                [newarray removeObjectAtIndex:i];
            }
            else 
            {
                // check whether any of those keycodes is already in use on this screen
                NSDictionary *keydefs = [def_existing registerKeys];
 
                foreach (key, [keydefs allKeys])
                {
                    j = [checklist count];
                    while (j--) 
                    {
                        if ([[NSString stringWithFormat:@"%@",[keydefs objectForKey:key]] isEqualToString:[NSString stringWithFormat:@"%@",[checklist objectAtIndex:j]]]) 
                        {
                            result = NO;
                            OOLog(kOOLogException, @"***** Exception in setExtraGuiScreenKeys: %@ : %@ (%@)", @"invalid key settings", @"key already in use", key);
                        }
                    }
                }
            }
        }
    }
    [newarray addObject:definition];
    // only add the item if there were no errors
    if (result) [extraGuiScreenKeys setObject:[newarray mutableCopy] forKey:[NSString stringWithFormat:@"%d",gui]];
    [newarray release];
    return result;
}

Referenced by GlobalSetExtraGuiScreenKeys().

Here is the caller graph for this function:

setExtraMissionKeys:

- (void) setExtraMissionKeys:

(NSDictionary *)

keys

Definition at line 9242 of file PlayerEntity.m.

                            :(NSDictionary *)keys
{
    NSString *key = nil;
    NSMutableDictionary *final = [[NSMutableDictionary alloc] init];
    foreach (key, [keys allKeys])
    {
        [final setObject:[self processKeyCode:[keys oo_arrayForKey:key]] forKey:key];
    }
    extraMissionKeys = [final copy];
    [final release];
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setFastEquipmentA:

- (void) setFastEquipmentA:

(NSString *)

eqKey

Definition at line 13727 of file PlayerEntity.m.

                          :(NSString *)eqKey
{
    [_fastEquipmentA release];
    _fastEquipmentA = [eqKey copy];
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setFastEquipmentB:

- (void) setFastEquipmentB:

(NSString *)

eqKey

Definition at line 13727 of file PlayerEntity.m.

                          :(NSString *)eqKey
{
    [_fastEquipmentB release];
    _fastEquipmentB = [eqKey copy];
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setForwardShieldLevel:

- (void) setForwardShieldLevel:

(GLfloat)

level

Definition at line 13727 of file PlayerEntity.m.

                              :(GLfloat)level
{
    forward_shield = OOClamp_0_max_f(level, [self maxForwardShieldLevel]);
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setForwardShieldRechargeRate:

- (void) setForwardShieldRechargeRate:

(float)

new

Definition at line 13727 of file PlayerEntity.m.

                                     :(float)new
{
    forward_shield_recharge_rate = new;
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setFoundTarget:

- (void) setFoundTarget: (Entity *)  targetEntity

implementation

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                       :(Entity *) targetEntity
{
    /* Rare, but can happen, e.g. if a Q-mine goes off nearby during
     * the sequence */
    if ([self status] == STATUS_ESCAPE_SEQUENCE)
    {
        return;
    }
    [_foundTarget release];
    _foundTarget = [targetEntity weakRetain];
}

setFuelLeak:

- (void) setFuelLeak:

(NSString *)

value

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                    :(NSString *)value
{   
    if (scriptTarget != self)
    {
        [scriptTarget setFuel:0];
        return;
    }
    
    fuel_leak_rate = [value doubleValue];
    if (fuel_leak_rate > 0)
    {
        [self playFuelLeak];
        [UNIVERSE addMessage:DESC(@"danger-fuel-leak") forCount:6];
        OOLog(kOOLogNoteFuelLeak, @"%@", @"FUEL LEAK activated!");
    }
}

setFuelLeakRate:

- (void) setFuelLeakRate:

(float)

value

Definition at line 13727 of file PlayerEntity.m.

                        :(float)value
{
    fuel_leak_rate = fmax(value, 0.0f);
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setGalacticHyperspaceBehaviour:

- (void) setGalacticHyperspaceBehaviour:

(OOGalacticHyperspaceBehaviour)

galacticHyperspaceBehaviour

Definition at line 9242 of file PlayerEntity.m.

                                       :(OOGalacticHyperspaceBehaviour)inBehaviour
{
    if (GALACTIC_HYPERSPACE_BEHAVIOUR_UNKNOWN < inBehaviour && inBehaviour <= GALACTIC_HYPERSPACE_MAX)
    {
        galacticHyperspaceBehaviour = inBehaviour;
    }
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setGalacticHyperspaceBehaviourTo:

- (void) setGalacticHyperspaceBehaviourTo:

(NSString *)

galacticHyperspaceBehaviourString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                                         :(NSString *)galacticHyperspaceBehaviourString
{
    OOGalacticHyperspaceBehaviour ghBehaviour = OOGalacticHyperspaceBehaviourFromString(galacticHyperspaceBehaviourString);
    if (ghBehaviour == GALACTIC_HYPERSPACE_BEHAVIOUR_UNKNOWN)
    {
        OOLog(@"player.setGalacticHyperspaceBehaviour.invalidInput",
              @"setGalacticHyperspaceBehaviourTo: called with unknown behaviour %@.", galacticHyperspaceBehaviourString);
    }
    [self setGalacticHyperspaceBehaviour:ghBehaviour];
}

setGalacticHyperspaceFixedCoords:

- (void) setGalacticHyperspaceFixedCoords:

(NSPoint)

point

Definition at line 9242 of file PlayerEntity.m.

                                         :(NSPoint)point
{
    return [self setGalacticHyperspaceFixedCoordsX:OOClamp_0_max_f(round(point.x), 255.0f) y:OOClamp_0_max_f(round(point.y), 255.0f)];
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setGalacticHyperspaceFixedCoordsTo:

- (void) setGalacticHyperspaceFixedCoordsTo:

(NSString *)

galacticHyperspaceFixedCoordsString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                                           :(NSString *)galacticHyperspaceFixedCoordsString
{   
    NSArray *coord_vals = ScanTokensFromString(galacticHyperspaceFixedCoordsString);
    if ([coord_vals count] < 2) // Will be 0 if string is nil
    {
        OOLog(@"player.setGalacticHyperspaceFixedCoords.invalidInput", @"%@",
              @"setGalacticHyperspaceFixedCoords: called with bad specifier. Defaulting to Oolite standard.");
        galacticHyperspaceFixedCoords.x = galacticHyperspaceFixedCoords.y = 0x60;
    }
    
    [self setGalacticHyperspaceFixedCoordsX:[coord_vals oo_unsignedCharAtIndex:0]
                                          y:[coord_vals oo_unsignedCharAtIndex:1]];
}

setGalacticHyperspaceFixedCoordsX:y:

- (void) setGalacticHyperspaceFixedCoordsX:		(unsigned char)	x
y:		(unsigned char)	y

Definition at line 9242 of file PlayerEntity.m.

                                          :(unsigned char)x y:(unsigned char)y
{
    galacticHyperspaceFixedCoords.x = x;
    galacticHyperspaceFixedCoords.y = y;
}

setGalaxyCoordinates:

- (void) setGalaxyCoordinates:

(NSPoint)

newPosition

Definition at line 13727 of file PlayerEntity.m.

                             :(NSPoint)newPosition
{
    galaxy_coordinates.x = newPosition.x;
    galaxy_coordinates.y = newPosition.y;
}

setGuiToChartScreenFrom:

- (void) setGuiToChartScreenFrom:

(OOGUIScreenID)

oldScreen

Definition at line 13727 of file PlayerEntity.m.

                                : (OOGUIScreenID) oldScreen
{
    GuiDisplayGen   *gui = [UNIVERSE gui];
    
    BOOL            guiChanged = (oldScreen != gui_screen);
    
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:YES];
    
    target_system_id = [UNIVERSE findSystemNumberAtCoords:cursor_coordinates withGalaxy:galaxy_number includingHidden:NO];
    
    [UNIVERSE preloadPlanetTexturesForSystem:target_system_id];
    
    // GUI stuff
    {
        //[gui clearAndKeepBackground:!guiChanged];
        [gui setStarChartTitle];
        // refresh the short range chart cache, in case we've just loaded a save game with different local overrides, etc.
        [gui refreshStarChart];
        //[gui setText:targetSystemName forRow:19];
        // distance-f & est-travel-time-f are identical between short & long range charts in standard Oolite, however can be alterered separately via OXPs
        //[gui setText:OOExpandKey(@"short-range-chart-distance", distance) forRow:20];
        //NSString *travelTimeRow = @"";
        //if ([self hasHyperspaceMotor] && distance > 0.0 && distance * 10.0 <= fuel)
        //{
        //  double time = estimatedTravelTime;
        //  travelTimeRow = OOExpandKey(@"short-range-chart-est-travel-time", time);
        //}
        //[gui setText:travelTimeRow forRow:21];
        if (gui_screen == GUI_SCREEN_LONG_RANGE_CHART)
        {
            NSString *displaySearchString = planetSearchString ? [planetSearchString capitalizedString] : (NSString *)@"";
            [gui setText:[NSString stringWithFormat:DESC(@"long-range-chart-find-planet-@"), displaySearchString] forRow:GUI_ROW_PLANET_FINDER];
            [gui setColor:[OOColor cyanColor] forRow:GUI_ROW_PLANET_FINDER];
            [gui setShowTextCursor:YES];
            [gui setCurrentRow:GUI_ROW_PLANET_FINDER];
        }
        else
        {
            [gui setShowTextCursor:NO];
        }
    }
    /* ends */
    
    [self setShowDemoShips:NO];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
    
    if (guiChanged)
    {
        [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"overlay"];
        
        [gui setBackgroundTextureKey:@"short_range_chart"];
        if (found_system_id >= 0)
        {       
            [UNIVERSE findSystemCoordinatesWithPrefix:[[UNIVERSE getSystemName:found_system_id] lowercaseString] exactMatch:YES];
        }
        [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
    }
}

setGuiToConfirmClearScreen

- (void) setGuiToConfirmClearScreen

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

{
    GuiDisplayGen *gui=[UNIVERSE gui];
    OOGUIScreenID oldScreen = gui_screen;
    
    gui_screen = GUI_SCREEN_KEYBOARD_CONFIRMCLEAR;
    BOOL guiChanged = (oldScreen != gui_screen);
    
    [gui clear];
    [gui setTitle:[NSString stringWithFormat:@"%@", DESC(@"oolite-keyconfig-clear-overrides-title")]];
    
    [gui addLongText:[NSString stringWithFormat:@"%@", DESC(@"oolite-keyconfig-clear-overrides")]
                                startingAtRow:GUI_ROW_KC_CONFIRMCLEAR align:GUI_ALIGN_LEFT];
    
    [gui setText:DESC(@"oolite-keyconfig-clear-yes") forRow: GUI_ROW_KC_CONFIRMCLEAR_YES align:GUI_ALIGN_CENTER];
    [gui setKey:GUI_KEY_OK forRow:GUI_ROW_KC_CONFIRMCLEAR_YES];
    
    [gui setText:DESC(@"oolite-keyconfig-clear-no") forRow:GUI_ROW_KC_CONFIRMCLEAR_NO align:GUI_ALIGN_CENTER];
    [gui setKey:GUI_KEY_OK forRow:GUI_ROW_KC_CONFIRMCLEAR_NO];
    
    [gui setSelectableRange:NSMakeRange(GUI_ROW_KC_CONFIRMCLEAR_YES, 2)];
    [gui setSelectedRow:GUI_ROW_KC_CONFIRMCLEAR_NO];
 
    [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"paused_overlay"];
    [gui setBackgroundTextureKey:@"keyboardsettings"];
 
    [[UNIVERSE gameView] clearMouse];
    [[UNIVERSE gameView] clearKeys];
    if (guiChanged) [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
}

setGuiToDockingReportScreen

- (void) setGuiToDockingReportScreen

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    GuiDisplayGen   *gui = [UNIVERSE gui];
    
    OOGUIScreenID   oldScreen = gui_screen;
    gui_screen = GUI_SCREEN_REPORT;
    BOOL            guiChanged = (oldScreen != gui_screen); 
    
    OOGUIRow        i, text_row = 1;
    
    [dockingReport setString:[dockingReport stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
    
    // GUI stuff
    {
        [gui clearAndKeepBackground:!guiChanged];
        [gui setTitle:OOExpandKey(@"arrival-report-title")];
        
        for (i=1;i<=18;i++) {
            [gui setColor:[gui colorFromSetting:kGuiDockingReportColor defaultValue:nil] forRow:21];
        }
        
        // dockingReport might be a multi-line message
        
        while (([dockingReport length] > 0)&&(text_row < 18))
        {
            if ([dockingReport rangeOfString:@"\n"].location != NSNotFound)
            {
                while (([dockingReport rangeOfString:@"\n"].location != NSNotFound)&&(text_row < 18))
                {
                    NSUInteger line_break = [dockingReport rangeOfString:@"\n"].location;
                    NSString* line = [dockingReport substringToIndex:line_break];
                    [dockingReport deleteCharactersInRange: NSMakeRange( 0, line_break + 1)];
                    text_row = [gui addLongText:line startingAtRow:text_row align:GUI_ALIGN_LEFT];
                }
                [dockingReport setString:[dockingReport stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
            }
            else
            {
                text_row = [gui addLongText:[NSString stringWithString:dockingReport] startingAtRow:text_row align:GUI_ALIGN_LEFT];
                [dockingReport setString:@""];
            }
        }
        
        [gui setText:[NSString stringWithFormat:DESC_PLURAL(@"contracts-cash-@-load-d-of-d-passengers-d-of-d-berths", max_passengers), OOCredits(credits), current_cargo, [self maxAvailableCargoSpace], [passengers count], max_passengers]  forRow: GUI_ROW_MARKET_CASH];
        [gui setColor:[gui colorFromSetting:kGuiDockingSummaryColor defaultValue:nil] forRow:GUI_ROW_MARKET_CASH];      
 
        [gui setText:DESC(@"press-space-commander") forRow:21 align:GUI_ALIGN_CENTER];
        [gui setColor:[gui colorFromSetting:kGuiDockingContinueColor defaultValue:nil] forRow:21];
        [gui setShowTextCursor:NO];
    }
    /* ends */
    
    if (lastTextKey)
    {
        [lastTextKey release];
        lastTextKey = nil;
    }
    
    [self setShowDemoShips:NO];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO];
    
    if (guiChanged)
    {
        [gui setForegroundTextureKey:@"docked_overlay"];    // has to be docked!
        
        NSDictionary *bgDescriptor = [UNIVERSE screenTextureDescriptorForKey:@"report"];
        if (bgDescriptor == nil) bgDescriptor = [UNIVERSE screenTextureDescriptorForKey:@"status_docked"];
        if (bgDescriptor == nil) bgDescriptor = [UNIVERSE screenTextureDescriptorForKey:@"status"];
        [gui setBackgroundTextureDescriptor:bgDescriptor];
        [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
    }
}

setGuiToEquipShipScreen:

- (void) setGuiToEquipShipScreen:

(int)

skip

Definition at line 9242 of file PlayerEntity.m.

                                :(int)skip
{
    [self setGuiToEquipShipScreen:skip selectingFacingFor:nil];
}

Referenced by activateSelectedInterface.

Here is the caller graph for this function:

setGuiToEquipShipScreen:selectingFacingFor:

- (void) setGuiToEquipShipScreen:		(int)	skip
selectingFacingFor:		(NSString *)	eqKeyForSelectFacing

Definition at line 9242 of file PlayerEntity.m.

                                :(int)skipParam selectingFacingFor:(NSString *)eqKeyForSelectFacing
{
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:YES];
    
    missiles = [self countMissiles];
    OOEntityStatus searchStatus; // use STATUS_TEST, STATUS_DEAD & STATUS_ACTIVE
    NSString *showKey = nil;
    unsigned skip;
 
    if (skipParam < 0)
    {
        skip = 0;
        searchStatus = STATUS_TEST;
    }
    else
    {
        skip = skipParam;
        searchStatus = STATUS_ACTIVE;
    }
 
    // don't show a "Back" item if we're only skipping one item - just show the item
    if (skip == 1)
        skip = 0;
 
    double priceFactor = 1.0;
    OOTechLevelID techlevel = [[UNIVERSE currentSystemData] oo_intForKey:KEY_TECHLEVEL];
 
    StationEntity *dockedStation = [self dockedStation];
    if (dockedStation)
    {
        priceFactor = [dockedStation equipmentPriceFactor];
        if ([dockedStation equivalentTechLevel] != NSNotFound)
            techlevel = [dockedStation equivalentTechLevel];
    }
 
    // build an array of all equipment - and take away that which has been bought (or is not permitted)
    NSMutableArray      *equipmentAllowed = [NSMutableArray array];
    
    // find options that agree with this ship
    OOShipRegistry      *registry = [OOShipRegistry sharedRegistry];
    NSDictionary        *shipyardInfo = [registry shipyardInfoForKey:[self shipDataKey]];
    NSMutableSet        *options = [NSMutableSet setWithArray:[shipyardInfo oo_arrayForKey:KEY_OPTIONAL_EQUIPMENT]];
    
    // add standard items too!
    [options addObjectsFromArray:[[shipyardInfo oo_dictionaryForKey:KEY_STANDARD_EQUIPMENT] oo_arrayForKey:KEY_EQUIPMENT_EXTRAS]];
    
    unsigned            i = 0;
    NSEnumerator        *eqEnum = nil;
    OOEquipmentType     *eqType = nil;
    unsigned            available_facings = [shipyardInfo oo_unsignedIntForKey:KEY_WEAPON_FACINGS defaultValue:[self weaponFacings]];   // use defaults  explicitly
 
    
    if (eqKeyForSelectFacing != nil) // Weapons purchase subscreen.
    {
        skip = 1;   // show the back button
        // The 3 lines below are needed by the present GUI. TODO:create a sane GUI. Kaks - 20090915 & 201005
        [equipmentAllowed addObject:eqKeyForSelectFacing];
        [equipmentAllowed addObject:eqKeyForSelectFacing];
        [equipmentAllowed addObject:eqKeyForSelectFacing];
    }
    else for (eqEnum = [OOEquipmentType equipmentEnumeratorOutfitting]; (eqType = [eqEnum nextObject]); i++)
    {
        NSString            *eqKey = [eqType identifier];
        OOTechLevelID       minTechLevel = [eqType effectiveTechLevel];
        
        // set initial availability to NO
        BOOL isOK = NO;
        
        // check special availability
        if ([eqType isAvailableToAll])  [options addObject:eqKey];
        
        // if you have a damaged system you can get it repaired at a tech level one less than that required to buy it
        if (minTechLevel != 0 && [self hasEquipmentItem:[eqType damagedIdentifier]])  minTechLevel--;
        
        // reduce the minimum techlevel occasionally as a bonus..
        if (techlevel < minTechLevel && techlevel + 3 > minTechLevel)
        {
            unsigned day = i * 13 + (unsigned)floor([UNIVERSE getTime] / 86400.0);
            unsigned char dayRnd = (day & 0xff) ^ (unsigned char)system_id;
            OOTechLevelID originalMinTechLevel = minTechLevel;
            
            while (minTechLevel > 0 && minTechLevel > originalMinTechLevel - 3 && !(dayRnd & 7))    // bargain tech days every 1/8 days
            {
                dayRnd = dayRnd >> 2;
                minTechLevel--; // occasional bonus items according to TL
            }
        }
        
        // check initial availability against options AND standard extras
        if ([options containsObject:eqKey])
        {
            isOK = YES;
            [options removeObject:eqKey];
        }
 
        if (isOK)
        {
            if (techlevel < minTechLevel) isOK = NO;
            if (![self canAddEquipment:eqKey inContext:@"purchase"]) isOK = NO;
            if (available_facings == 0 && [eqType isPrimaryWeapon]) isOK = NO;
            if (isOK)  [equipmentAllowed addObject:eqKey];
        }
        
        if (searchStatus == STATUS_DEAD && isOK)
        {
            showKey = eqKey;
            searchStatus = STATUS_ACTIVE;
        }
        if (searchStatus == STATUS_TEST)
        {
            if (isOK) showKey = eqKey;
            if ([eqKey isEqualToString:last_outfitting_key]) 
                searchStatus = isOK ? STATUS_ACTIVE : STATUS_DEAD;
        }
    }
    if (searchStatus != STATUS_TEST && showKey != nil)
    {
        [last_outfitting_key release];
        last_outfitting_key = [showKey copy];
    }
    
    // GUI stuff
    {
        GuiDisplayGen   *gui = [UNIVERSE gui];
        OOGUIRow        start_row = GUI_ROW_EQUIPMENT_START;
        OOGUIRow        row = start_row;
        unsigned        facing_count = 0;
        BOOL            displayRow = YES;
        BOOL            weaponMounted = NO;
        BOOL            guiChanged = (gui_screen != GUI_SCREEN_EQUIP_SHIP);
 
        gui_screen = GUI_SCREEN_EQUIP_SHIP;
 
        [gui clearAndKeepBackground:!guiChanged];
        [gui setTitle:DESC(@"equip-title")];
        
        [gui setColor:[gui colorFromSetting:kGuiEquipmentCashColor defaultValue:nil] forRow: GUI_ROW_EQUIPMENT_CASH];
        [gui setText:OOExpandKey(@"equip-cash-value", credits) forRow:GUI_ROW_EQUIPMENT_CASH];
        
        OOGUITabSettings tab_stops;
        tab_stops[0] = 0;
        tab_stops[1] = -360;
        tab_stops[2] = -480;
        [gui overrideTabs:tab_stops from:kGuiEquipmentTabs length:3];
        [gui setTabStops:tab_stops];
        
        unsigned n_rows = GUI_MAX_ROWS_EQUIPMENT;
        NSUInteger count = [equipmentAllowed count];
 
        if (count > 0)
        {
            if (skip > 0)   // lose the first row to Back <--
            {
                unsigned previous;
 
                if (count <= n_rows || skip < n_rows)
                    previous = 0;                   // single page
                else
                {
                    previous = skip - (n_rows - 2); // multi-page. 
                    if (previous < 2)
                        previous = 0;               // if only one previous item, just show it
                }
 
                if (eqKeyForSelectFacing != nil)
                {
                    previous = 0;
                    // keep weapon selected if we go back.
                    [gui setKey:[NSString stringWithFormat:@"More:%d:%@", previous, eqKeyForSelectFacing] forRow:row];
                }
                else
                {
                    [gui setKey:[NSString stringWithFormat:@"More:%d", previous] forRow:row];
                }
                [gui setColor:[gui colorFromSetting:kGuiEquipmentScrollColor defaultValue:[OOColor greenColor]] forRow:row];
                [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-back"), @"", @" <-- ", nil] forRow:row];
                row++;
            }
            
            for (i = skip; i < count && (row - start_row < (OOGUIRow)n_rows); i++)
            {
                NSString            *eqKey = [equipmentAllowed oo_stringAtIndex:i];
                OOEquipmentType     *eqInfo = [OOEquipmentType equipmentTypeWithIdentifier:eqKey];
                OOCreditsQuantity   pricePerUnit = [eqInfo price];
                NSString            *desc = [NSString stringWithFormat:@" %@ ", [eqInfo name]];
                NSString            *eq_key_damaged = [eqInfo damagedIdentifier];
                double              price;
 
                OOColor             *dispCol = [eqInfo displayColor];
                if (dispCol == nil) dispCol = [gui colorFromSetting:kGuiEquipmentOptionColor defaultValue:nil];
                [gui setColor:dispCol forRow:row]; 
 
                if ([eqKey isEqual:@"EQ_FUEL"])
                {
                    price = (PLAYER_MAX_FUEL - fuel) * pricePerUnit * [self fuelChargeRate];
                }
                else if ([eqKey isEqualToString:@"EQ_RENOVATION"])
                {
                    price = [self renovationCosts];
                    [gui setColor:[gui colorFromSetting:kGuiEquipmentRepairColor defaultValue:[OOColor orangeColor]] forRow:row];
                }
                else
                {
                    price = pricePerUnit;
                }
                
                price = [self adjustPriceByScriptForEqKey:eqKey withCurrent:price];
 
                price *= priceFactor;  // increased prices at some stations
                
                NSUInteger installTime = [eqInfo installTime];
                if (installTime == 0)
                {
                    installTime = 600 + price;
                }
                // is this item damaged?
                if ([self hasEquipmentItem:eq_key_damaged])
                {
                    desc = [NSString stringWithFormat:DESC(@"equip-repair-@"), desc];
                    price /= 2.0;
                    installTime = [eqInfo repairTime];
                    if (installTime == 0)
                    {
                        installTime = 600 + price;
                    }
                    [gui setColor:[gui colorFromSetting:kGuiEquipmentRepairColor defaultValue:[OOColor orangeColor]] forRow:row];
 
                }
                
                NSString *timeString = [UNIVERSE shortTimeDescription:installTime];
                NSString *priceString = [NSString stringWithFormat:@" %@ ", OOCredits(price)];
 
                if ([eqKeyForSelectFacing isEqualToString:eqKey])
                {
                    // Weapons purchase subscreen.
                    while (facing_count < 5)
                    {
                        NSUInteger multiplier = 1;
                        switch (facing_count)
                        {
                            case 0:
                                break;
                                
                            case 1:
                                displayRow = available_facings & WEAPON_FACING_FORWARD;
                                desc = FORWARD_FACING_STRING;
                                weaponMounted = !isWeaponNone(forward_weapon_type);
                                if (_multiplyWeapons)
                                {
                                    multiplier = [forwardWeaponOffset count];
                                }
                                break;
                                
                            case 2:
                                displayRow = available_facings & WEAPON_FACING_AFT;
                                desc = AFT_FACING_STRING;
                                weaponMounted = !isWeaponNone(aft_weapon_type);
                                if (_multiplyWeapons)
                                {
                                    multiplier = [aftWeaponOffset count];
                                }
                                break;
                                
                            case 3:
                                displayRow = available_facings & WEAPON_FACING_PORT;
                                desc = PORT_FACING_STRING;
                                weaponMounted = !isWeaponNone(port_weapon_type);
                                if (_multiplyWeapons)
                                {
                                    multiplier = [portWeaponOffset count];
                                }
                                break;
                                
                            case 4:
                                displayRow = available_facings & WEAPON_FACING_STARBOARD;
                                desc = STARBOARD_FACING_STRING;
                                weaponMounted = !isWeaponNone(starboard_weapon_type);
                                if (_multiplyWeapons)
                                {
                                    multiplier = [starboardWeaponOffset count];
                                }
                                break;
                        }
                        
                        if(weaponMounted)
                        {
                            [gui setColor:[gui colorFromSetting:kGuiEquipmentLaserFittedColor defaultValue:[OOColor colorWithRed:0.0f green:0.6f blue:0.0f alpha:1.0f]] forRow:row];
                        }
                        else
                        {
                            [gui setColor:[gui colorFromSetting:kGuiEquipmentLaserColor defaultValue:[OOColor greenColor]] forRow:row];
                        }
                        if (displayRow) // Always true for the first pass. The first pass is used to display the name of the weapon being purchased.
                        {
 
                            priceString = [NSString stringWithFormat:@" %@ ", OOCredits(price*multiplier)];
 
                            [gui setKey:eqKey forRow:row];
                            [gui setArray:[NSArray arrayWithObjects:desc, (facing_count > 0 ? priceString : (NSString *)@""), timeString, nil] forRow:row];
                            row++;
                        }
                        facing_count++;
                    }
                }
                else
                {
                    // Normal equipment list.
                    [gui setKey:eqKey forRow:row];
                    // check if the hidevalues property has been set
                    if (![eqInfo hideValues])
                    {
                        [gui setArray:[NSArray arrayWithObjects:desc, priceString, timeString, nil] forRow:row];
                    }
                    else
                    {
                        // if so, only output the description
                        [gui setArray:[NSArray arrayWithObjects:desc, nil] forRow:row];
                    }
                    row++;
                }
            }
 
            if (i < count)
            {
                // just overwrite the last item :-)
                [gui setColor:[gui colorFromSetting:kGuiEquipmentScrollColor defaultValue:[OOColor greenColor]] forRow:row-1];
                [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-more"), @"", @" --> ", nil] forRow:row - 1];
                [gui setKey:[NSString stringWithFormat:@"More:%d", i - 1] forRow:row - 1];
            }
            
            [gui setSelectableRange:NSMakeRange(start_row,row - start_row)];
 
            if ([gui selectedRow] != start_row)
                [gui setSelectedRow:start_row];
 
            if (eqKeyForSelectFacing != nil)
            {
                [gui setSelectedRow:start_row + 1];
                [self showInformationForSelectedUpgradeWithFormatString:DESC(@"@-select-where-to-install")];
            }
            else
            {
                [self showInformationForSelectedUpgrade];
            }
        }
        else
        {
            [gui setText:DESC(@"equip-no-equipment-available-for-purchase") forRow:GUI_ROW_NO_SHIPS align:GUI_ALIGN_CENTER];
            [gui setColor:[gui colorFromSetting:kGuiEquipmentUnavailableColor defaultValue:[OOColor greenColor]] forRow:GUI_ROW_NO_SHIPS];
            
            [gui setSelectableRange:NSMakeRange(0,0)];
            [gui setNoSelectedRow];
            [self showInformationForSelectedUpgrade];
        }
        
        [gui setShowTextCursor:NO];
        
        // TODO: split the mount_weapon sub-screen into a separate screen, and use it for pylon mounted wepons as well?
        if (guiChanged)
        {
            [gui setForegroundTextureKey:@"docked_overlay"];
            NSDictionary *background = [UNIVERSE screenTextureDescriptorForKey:@"equip_ship"];
            [self setEquipScreenBackgroundDescriptor:background];
            [gui setBackgroundTextureDescriptor:background];
        }
        else if (eqKeyForSelectFacing != nil) // weapon purchase
        {
            NSDictionary *bgDescriptor = [UNIVERSE screenTextureDescriptorForKey:@"mount_weapon"];
            if (bgDescriptor != nil)  [gui setBackgroundTextureDescriptor:bgDescriptor];
        }
        else // Returning from a weapon purchase. (Also called, redundantly, when paging)
        {
            [gui setBackgroundTextureDescriptor:[self equipScreenBackgroundDescriptor]];
        }
    }
    /* ends */
 
    chosen_weapon_facing = WEAPON_FACING_NONE;
 
    [self setShowDemoShips:NO];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
}

setGuiToGameOptionsScreen

- (void) setGuiToGameOptionsScreen

Definition at line 8865 of file PlayerEntity.m.

{
    MyOpenGLView *gameView = [UNIVERSE gameView];
 
    [[UNIVERSE gameView] clearMouse];
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:YES];
 
    gui_screen = GUI_SCREEN_GAMEOPTIONS;
 
    // GUI stuff
    {
        #define OO_SETACCESSCONDITIONFORROW(condition, row)             \
        do {                                                    \
            if ((condition))                                    \
            {                                               \
                [gui setKey:GUI_KEY_OK forRow:(row)];           \
            }                                               \
            else                                                \
            {                                               \
                [gui setColor:[OOColor grayColor] forRow:(row)];    \
            }                                               \
        } while(0)
        BOOL startingGame = [self status] == STATUS_START_GAME;
        GuiDisplayGen* gui = [UNIVERSE gui];
        GUI_ROW_INIT(gui);
 
        int first_sel_row = GUI_FIRST_ROW(GAME)-4; // repositioned menu
 
        [gui clear];
        [gui setTitle:[NSString stringWithFormat:DESC(@"status-commander-@"), [self commanderName]]]; // Same title as status screen.
        
#if OO_RESOLUTION_OPTION
        GameController  *controller = [UNIVERSE gameController];
        
        NSUInteger      displayModeIndex = [controller indexOfCurrentDisplayMode];
        if (displayModeIndex == NSNotFound)
        {
            OOLogWARN(@"display.currentMode.notFound", @"%@", @"couldn't find current fullscreen setting, switching to default.");
            displayModeIndex = 0;
        }
        
        NSArray         *modeList = [controller displayModes];
        NSDictionary    *mode = nil;
        if ([modeList count])
        {
            mode = [modeList objectAtIndex:displayModeIndex];
        }
        if (mode == nil)  return;   // Got a better idea?
        
        unsigned modeWidth = [mode oo_unsignedIntForKey:kOODisplayWidth];
        unsigned modeHeight = [mode oo_unsignedIntForKey:kOODisplayHeight];
        float modeRefresh = [mode oo_floatForKey:kOODisplayRefreshRate];
 
        BOOL runningOnPrimaryDisplayDevice = [gameView isRunningOnPrimaryDisplayDevice];
#if OOLITE_WINDOWS
        if (!runningOnPrimaryDisplayDevice)
        {
            MONITORINFOEX mInfo = [gameView currentMonitorInfo];
            modeWidth = mInfo.rcMonitor.right - mInfo.rcMonitor.left;
            modeHeight = mInfo.rcMonitor.bottom - mInfo.rcMonitor.top;
        }
#endif
        
        NSString *displayModeString = [self screenModeStringForWidth:modeWidth height:modeHeight refreshRate:modeRefresh];
        
        [gui setText:displayModeString forRow:GUI_ROW(GAME,DISPLAY) align:GUI_ALIGN_CENTER];
        if (runningOnPrimaryDisplayDevice)
        {
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,DISPLAY)];
        }
        else
        {
            [gui setColor:[OOColor grayColor] forRow:GUI_ROW(GAME,DISPLAY)];
        }
#endif  // OO_RESOLUTIOM_OPTION
 
 
#if OOLITE_WINDOWS
        if ([gameView hdrOutput])
        {
            NSArray     *brightnesses = [[UNIVERSE descriptions] oo_arrayForKey: @"hdr_maxBrightness_array"];
            int         brightnessIdx = [brightnesses indexOfObject:[NSString stringWithFormat:@"%d", (int)[gameView hdrMaxBrightness]]];
            
            if (brightnessIdx == NSNotFound)
            {
                OOLogWARN(@"hdr.maxBrightness.notFound", @"%@", @"couldn't find current max brightness setting, switching to 400 nits.");
                brightnessIdx = 0;
            }
                
            int brightnessValue = [brightnesses oo_intAtIndex:brightnessIdx];
            NSString *maxBrightnessString = OOExpandKey(@"gameoptions-hdr-maxbrightness", brightnessValue);
                                                                                
            [gui setText:maxBrightnessString forRow:GUI_ROW(GAME,HDRMAXBRIGHTNESS)  align:GUI_ALIGN_CENTER];
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,HDRMAXBRIGHTNESS)];
        }
#endif
 
 
        if ([UNIVERSE autoSave])
            [gui setText:DESC(@"gameoptions-autosave-yes") forRow:GUI_ROW(GAME,AUTOSAVE) align:GUI_ALIGN_CENTER];
        else
            [gui setText:DESC(@"gameoptions-autosave-no") forRow:GUI_ROW(GAME,AUTOSAVE) align:GUI_ALIGN_CENTER];
        [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,AUTOSAVE)];
    
        // volume control
        if ([OOSound respondsToSelector:@selector(masterVolume)] && [OOSound isSoundOK])
        {
            double volume = 100.0 * [OOSound masterVolume];
            int vol = (volume / 5.0 + 0.5); // avoid rounding errors
            NSString* soundVolumeWordDesc = DESC(@"gameoptions-sound-volume");
            if (vol > 0)
                [gui setText:[NSString stringWithFormat:@"%@%@ ", soundVolumeWordDesc, SliderString(vol)] forRow:GUI_ROW(GAME,VOLUME) align:GUI_ALIGN_CENTER];
            else
                [gui setText:DESC(@"gameoptions-sound-volume-mute") forRow:GUI_ROW(GAME,VOLUME) align:GUI_ALIGN_CENTER];
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,VOLUME)];
        }
        else
        {
            [gui setText:DESC(@"gameoptions-volume-external-only") forRow:GUI_ROW(GAME,VOLUME) align:GUI_ALIGN_CENTER];
            [gui setColor:[OOColor grayColor] forRow:GUI_ROW(GAME,VOLUME)];
        }
        
 
        // field of view control
        float fov = [gameView fov:NO];
        int fovTicks = (int)((fov - MIN_FOV_DEG) * 20 / (MAX_FOV_DEG - MIN_FOV_DEG));
        NSString* fovWordDesc = DESC(@"gameoptions-fov-value");
        [gui setText:[NSString stringWithFormat:@"%@%@ (%d%c) ", fovWordDesc, SliderString(fovTicks), (int)fov, 176 /*176 is the degrees symbol Unicode code point*/] forRow:GUI_ROW(GAME,FOV) align:GUI_ALIGN_CENTER];
        [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,FOV)];
        
        // color blind mode
        int colorblindMode = [UNIVERSE colorblindMode];
        NSString *colorblindModeDesc = [[[UNIVERSE descriptions] oo_arrayForKey: @"colorblind_mode"] oo_stringAtIndex:[UNIVERSE useShaders] ? colorblindMode : 0];
        NSString *colorblindModeMsg = OOExpandKey(@"gameoptions-colorblind-mode", colorblindModeDesc);
        [gui setText:colorblindModeMsg forRow:GUI_ROW(GAME,COLORBLINDMODE) align:GUI_ALIGN_CENTER];
        if ([UNIVERSE useShaders])
        {
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,COLORBLINDMODE)];
        }
        else
        {
            [gui setColor:[OOColor grayColor] forRow:GUI_ROW(GAME,COLORBLINDMODE)];
        }
        
#if OOLITE_SPEECH_SYNTH
        // Speech control
        switch (isSpeechOn)
        {
        case OOSPEECHSETTINGS_OFF:
            [gui setText:DESC(@"gameoptions-spoken-messages-no") forRow:GUI_ROW(GAME,SPEECH) align:GUI_ALIGN_CENTER];
            break;
        case OOSPEECHSETTINGS_COMMS:
            [gui setText:DESC(@"gameoptions-spoken-messages-comms") forRow:GUI_ROW(GAME,SPEECH) align:GUI_ALIGN_CENTER];
            break;
        case OOSPEECHSETTINGS_ALL:
            [gui setText:DESC(@"gameoptions-spoken-messages-yes") forRow:GUI_ROW(GAME,SPEECH) align:GUI_ALIGN_CENTER];
            break;
        }
        OO_SETACCESSCONDITIONFORROW(!startingGame, GUI_ROW(GAME,SPEECH));
        
#if OOLITE_ESPEAK
        {
            NSString *voiceName = [UNIVERSE voiceName:voice_no];
            NSString *message = OOExpandKey(@"gameoptions-voice-name", voiceName);
            [gui setText:message forRow:GUI_ROW(GAME,SPEECH_LANGUAGE) align:GUI_ALIGN_CENTER];
            OO_SETACCESSCONDITIONFORROW(!startingGame, GUI_ROW(GAME,SPEECH_LANGUAGE));
 
            message = [NSString stringWithFormat:@"%@", DESC(voice_gender_m ? @"gameoptions-voice-M" : @"gameoptions-voice-F")];
            [gui setText:message forRow:GUI_ROW(GAME,SPEECH_GENDER) align:GUI_ALIGN_CENTER];
            OO_SETACCESSCONDITIONFORROW(!startingGame, GUI_ROW(GAME,SPEECH_GENDER));
        }
#endif
#endif
#if !OOLITE_MAC_OS_X
        // window/fullscreen
        if([gameView inFullScreenMode])
        {
            [gui setText:DESC(@"gameoptions-play-in-window") forRow:GUI_ROW(GAME,DISPLAYSTYLE) align:GUI_ALIGN_CENTER];
        }
        else
        {
            [gui setText:DESC(@"gameoptions-play-in-fullscreen") forRow:GUI_ROW(GAME,DISPLAYSTYLE) align:GUI_ALIGN_CENTER];
        }
        [gui setKey: GUI_KEY_OK forRow: GUI_ROW(GAME,DISPLAYSTYLE)];
#endif
        
        [gui setText:DESC(@"gameoptions-joystick-configuration") forRow: GUI_ROW(GAME,STICKMAPPER) align: GUI_ALIGN_CENTER];
        OO_SETACCESSCONDITIONFORROW([[OOJoystickManager sharedStickHandler] joystickCount], GUI_ROW(GAME,STICKMAPPER));
 
        [gui setText:DESC(@"gameoptions-keyboard-configuration") forRow: GUI_ROW(GAME,KEYMAPPER) align: GUI_ALIGN_CENTER];
        [gui setKey: GUI_KEY_OK forRow: GUI_ROW(GAME,KEYMAPPER)];
 
        
        NSString *musicMode = [UNIVERSE descriptionForArrayKey:@"music-mode" index:[[OOMusicController sharedController] mode]];
        NSString *message = OOExpandKey(@"gameoptions-music-mode", musicMode);
        [gui setText:message forRow:GUI_ROW(GAME,MUSIC) align:GUI_ALIGN_CENTER];
        [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,MUSIC)];
 
        if (![gameView hdrOutput])
        {
            if ([UNIVERSE wireframeGraphics])
                [gui setText:DESC(@"gameoptions-wireframe-graphics-yes") forRow:GUI_ROW(GAME,WIREFRAMEGRAPHICS) align:GUI_ALIGN_CENTER];
            else
                [gui setText:DESC(@"gameoptions-wireframe-graphics-no") forRow:GUI_ROW(GAME,WIREFRAMEGRAPHICS) align:GUI_ALIGN_CENTER];
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,WIREFRAMEGRAPHICS)];
        }
#if OOLITE_WINDOWS
        else
        {
            float paperWhite = [gameView hdrPaperWhiteBrightness];
            int paperWhiteTicks = (int)((paperWhite - MIN_HDR_PAPERWHITE) * 20 / (MAX_HDR_PAPERWHITE - MIN_HDR_PAPERWHITE));
            NSString* paperWhiteWordDesc = DESC(@"gameoptions-hdr-paperwhite");
            [gui setText:[NSString stringWithFormat:@"%@%@ (%d) ", paperWhiteWordDesc, SliderString(paperWhiteTicks), (int)paperWhite] forRow:GUI_ROW(GAME,HDRPAPERWHITE) align:GUI_ALIGN_CENTER];
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,HDRPAPERWHITE)];
        }
#endif
        
#if !NEW_PLANETS
        if ([UNIVERSE doProcedurallyTexturedPlanets])
            [gui setText:DESC(@"gameoptions-procedurally-textured-planets-yes") forRow:GUI_ROW(GAME,PROCEDURALLYTEXTUREDPLANETS) align:GUI_ALIGN_CENTER];
        else
            [gui setText:DESC(@"gameoptions-procedurally-textured-planets-no") forRow:GUI_ROW(GAME,PROCEDURALLYTEXTUREDPLANETS) align:GUI_ALIGN_CENTER];
        [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,PROCEDURALLYTEXTUREDPLANETS)];
#endif
 
        OOGraphicsDetail detailLevel = [UNIVERSE detailLevel];
        NSString *shaderEffectsOptionsString = OOExpand(@"gameoptions-detaillevel-[detailLevel]", detailLevel);
        [gui setText:OOExpandKey(shaderEffectsOptionsString) forRow:GUI_ROW(GAME,SHADEREFFECTS) align:GUI_ALIGN_CENTER];
        if (![[OOOpenGLExtensionManager sharedManager] shadersForceDisabled])
        {
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,SHADEREFFECTS)];
        }
        else
        {
            // deactivate this option if shaders have been disabled from the commend line
            [gui setColor:[OOColor grayColor] forRow:GUI_ROW(GAME,SHADEREFFECTS)];
        }
        
        
        if ([UNIVERSE dockingClearanceProtocolActive])
        {
            [gui setText:DESC(@"gameoptions-docking-clearance-yes") forRow:GUI_ROW(GAME,DOCKINGCLEARANCE) align:GUI_ALIGN_CENTER];
        }
        else
        {
            [gui setText:DESC(@"gameoptions-docking-clearance-no") forRow:GUI_ROW(GAME,DOCKINGCLEARANCE) align:GUI_ALIGN_CENTER];
        }
        OO_SETACCESSCONDITIONFORROW(!startingGame, GUI_ROW(GAME,DOCKINGCLEARANCE));
        
        // Back menu option
        [gui setText:DESC(@"gui-back") forRow:GUI_ROW(GAME,BACK) align:GUI_ALIGN_CENTER];
        [gui setKey:GUI_KEY_OK forRow:GUI_ROW(GAME,BACK)];
 
        [gui setSelectableRange:NSMakeRange(first_sel_row, GUI_ROW_GAMEOPTIONS_END_OF_LIST)];
        [gui setSelectedRow: first_sel_row];
 
        [gui setShowTextCursor:NO];
        [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"paused_overlay"];
        [gui setBackgroundTextureKey:@"settings"];
    }
    /* ends */
 
    [self setShowDemoShips:NO];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
}

setGuiToInterfacesScreen:

- (void) setGuiToInterfacesScreen:

(int)

skip

Definition at line 9242 of file PlayerEntity.m.

                                 :(int)skip
{
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:YES];
    if (gui_screen != GUI_SCREEN_INTERFACES)
    {
        [self noteGUIWillChangeTo:GUI_SCREEN_INTERFACES];
    }
    
    // build an array of available interfaces
    NSDictionary *interfaces = [[self dockedStation] localInterfaces];
    NSArray     *interfaceKeys = [interfaces keysSortedByValueUsingSelector:@selector(interfaceCompare:)]; // sorts by category, then title
    int i;
 
    OOGUIScreenID   oldScreen = gui_screen;
 
    // GUI stuff
    {
        GuiDisplayGen   *gui = [UNIVERSE gui];
        OOGUIRow        start_row = GUI_ROW_INTERFACES_START;
        OOGUIRow        row = start_row;
        BOOL            guiChanged = (gui_screen != GUI_SCREEN_INTERFACES);
 
        [gui clearAndKeepBackground:!guiChanged];
        [gui setTitle:DESC(@"interfaces-title")];
        
        gui_screen = GUI_SCREEN_INTERFACES;
        
        OOGUITabSettings tab_stops;
        tab_stops[0] = 0;
        tab_stops[1] = -480;
        [gui overrideTabs:tab_stops from:kGuiInterfaceTabs length:2];
        [gui setTabStops:tab_stops];
        
        unsigned n_rows = GUI_MAX_ROWS_INTERFACES;
        NSUInteger count = [interfaceKeys count];
 
        if (count > 0)
        {
            if (skip > 0)   // lose the first row to Back <--
            {
                unsigned previous;
                
                if (count <= n_rows || skip < (NSInteger)n_rows)
                {
                    previous = 0;                   // single page
                }
                else
                {
                    previous = skip - (n_rows - 2); // multi-page. 
                    if (previous < 2)
                    {
                        previous = 0;               // if only one previous item, just show it
                    }
                }
                
                [gui setKey:[NSString stringWithFormat:@"More:%d", previous] forRow:row];
                [gui setColor:[gui colorFromSetting:kGuiInterfaceScrollColor defaultValue:[OOColor greenColor]] forRow:row];
                [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-back"), @" <-- ", nil] forRow:row];
                row++;
            }
            
            for (i = skip; i < (NSInteger)count && (row - start_row < (OOGUIRow)n_rows); i++)
            {
                NSString *interfaceKey = [interfaceKeys objectAtIndex:i];
                OOJSInterfaceDefinition *definition = [interfaces objectForKey:interfaceKey];
 
                [gui setColor:[gui colorFromSetting:kGuiInterfaceEntryColor defaultValue:nil] forRow:row];
                [gui setKey:interfaceKey forRow:row];
                [gui setArray:[NSArray arrayWithObjects:[definition title],[definition category], nil] forRow:row];
 
                row++;
            }
 
            if (i < (NSInteger)count)
            {
                // just overwrite the last item :-)
                [gui setColor:[gui colorFromSetting:kGuiInterfaceScrollColor defaultValue:[OOColor greenColor]] forRow:row - 1];
                [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-more"), @" --> ", nil] forRow:row - 1];
                [gui setKey:[NSString stringWithFormat:@"More:%d", i - 1] forRow:row - 1];
            }
            
            [gui setSelectableRange:NSMakeRange(start_row,row - start_row)];
 
            if ([gui selectedRow] != start_row)
            {
                [gui setSelectedRow:start_row];
            }
 
            [self showInformationForSelectedInterface];
        }
        else
        {
            [gui setText:DESC(@"interfaces-no-interfaces-available-for-use") forRow:GUI_ROW_NO_INTERFACES align:GUI_ALIGN_LEFT];
            [gui setColor:[gui colorFromSetting:kGuiInterfaceNoneColor defaultValue:[OOColor greenColor]] forRow:GUI_ROW_NO_INTERFACES];
            
            [gui setSelectableRange:NSMakeRange(0,0)];
            [gui setNoSelectedRow];
 
        }
        
        [gui setShowTextCursor:NO];
 
        NSString *desc = [NSString stringWithFormat:DESC(@"interfaces-for-ship-@-and-station-@"), [self displayName], [[self dockedStation] displayName]];
        [gui setColor:[gui colorFromSetting:kGuiInterfaceHeadingColor defaultValue:nil] forRow:GUI_ROW_INTERFACES_HEADING];
        [gui setText:desc forRow:GUI_ROW_INTERFACES_HEADING];
 
        
        if (guiChanged)
        {
            [gui setForegroundTextureKey:@"docked_overlay"];
            NSDictionary *background = [UNIVERSE screenTextureDescriptorForKey:@"interfaces"];
            [gui setBackgroundTextureDescriptor:background];
        }
    }
    /* ends */
 
    [self setShowDemoShips:NO];
    
    [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
    
    [self setShowDemoShips:NO];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
 
}

setGuiToKeyboardLayoutScreen:

- (void) setGuiToKeyboardLayoutScreen:

(unsigned)

skip

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                     :(unsigned)skip
{
    [self setGuiToKeyboardLayoutScreen:skip resetCurrentRow:NO];
}

setGuiToKeyboardLayoutScreen:resetCurrentRow:

- (void) setGuiToKeyboardLayoutScreen:		(unsigned)	skip
resetCurrentRow:		(BOOL)	resetCurrentRow

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                     :(unsigned)skip resetCurrentRow:(BOOL)resetCurrentRow
{
    GuiDisplayGen *gui = [UNIVERSE gui];
    MyOpenGLView *gameView = [UNIVERSE gameView];
    OOGUIScreenID oldScreen = gui_screen;
    OOGUITabStop tabStop[GUI_MAX_COLUMNS];
    tabStop[0] = 10;
    tabStop[1] = 290;
    [gui setTabStops:tabStop];
 
    gui_screen = GUI_SCREEN_KEYBOARD_LAYOUT;
    BOOL guiChanged = (oldScreen != gui_screen);
 
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:YES];
 
    [gui clear];
    [gui setTitle:[NSString stringWithFormat:@"Select Keyboard Layout"]];
 
    [self displayKeyboardLayoutList:gui skip:skip];
 
    [gui setArray:[NSArray arrayWithObject:DESC(@"oolite-keyconfig-keyboard-info")] forRow:GUI_ROW_KC_INSTRUCT];
 
    [gui setSelectedRow:kbd_row];
 
    [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"paused_overlay"];
    [gui setBackgroundTextureKey:@"keyboardsettings"];
 
    [gameView clearMouse];
    [gameView clearKeys];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
 
    if (guiChanged) [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
}

setGuiToKeyConfigEntryScreen

- (void) setGuiToKeyConfigEntryScreen

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

{
    GuiDisplayGen *gui = [UNIVERSE gui];
    MyOpenGLView *gameView = [UNIVERSE gameView];
    OOGUIScreenID oldScreen = gui_screen;
    gui_screen = GUI_SCREEN_KEYBOARD_ENTRY;
    BOOL guiChanged = (oldScreen != gui_screen);
    
    // make sure the index we're looking for exists
    if ([key_list count] < (key_index + 1))
    {
        // add the missing element to the array
        NSMutableDictionary *key1 = [[NSMutableDictionary alloc] initWithObjectsAndKeys:@"", @"key", [NSNumber numberWithBool:NO], @"shift", [NSNumber numberWithBool:NO], @"mod1", [NSNumber numberWithBool:NO], @"mod2", nil];
        [key_list addObject:key1];
        [key1 release];
    }
    NSDictionary *def = [key_list objectAtIndex:key_index];
    NSString *key = [def objectForKey:@"key"];
    //if ([key isEqualToString:@"(not set)"]) key = @"";
    OOKeyCode k_int = (OOKeyCode)[key integerValue];
    [gameView resetTypedString];
    [gameView setTypedString:(k_int != 0 ? [self keyCodeDescriptionShort:k_int] : @"")];
    [gameView setStringInput:gvStringInputAll];
 
    [gui clear];
    [gui setTitle:[NSString stringWithFormat:@"%@", DESC(@"oolite-keyconfig-update-entry-title")]];
    
    NSUInteger end_row = 21;
    if ([[self hud] allowBigGui]) 
    {
        end_row = 27;
    }
 
    [gui addLongText:DESC(@"oolite-keyconfig-update-entry-info") startingAtRow:GUI_ROW_KC_ENTRY_INFO align:GUI_ALIGN_LEFT];
 
    [gui setText:[NSString stringWithFormat:DESC(@"Key: %@"), [gameView typedString]] forRow:end_row align:GUI_ALIGN_LEFT];
    [gui setColor:[OOColor cyanColor] forRow:end_row];
    [gui setSelectableRange:NSMakeRange(0,0)];
 
    [gui setShowTextCursor:YES];
    [gui setCurrentRow:end_row];
 
    [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"paused_overlay"];
    [gui setBackgroundTextureKey:@"keyboardsettings"];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO];
 
    [gameView clearMouse];
    [gameView clearKeys];
    if (guiChanged) [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
}

setGuiToKeyConfigScreen

- (void) setGuiToKeyConfigScreen

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

{
    [self setGuiToKeyConfigScreen:NO];
}

setGuiToKeyConfigScreen:

- (void) setGuiToKeyConfigScreen:

(BOOL)

resetSelectedRow

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                :(BOOL)resetSelectedRow
{
    NSUInteger i = 0;
    GuiDisplayGen *gui=[UNIVERSE gui];
    OOGUIScreenID oldScreen = gui_screen;
    OOGUITabStop tabStop[GUI_MAX_COLUMNS];
    tabStop[0] = 10;
    tabStop[1] = 290;
    [gui setTabStops:tabStop];
 
    gui_screen = GUI_SCREEN_KEYBOARD_CONFIG;
    BOOL guiChanged = (oldScreen != gui_screen);
    [gui clear];
    [gui setTitle:[NSString stringWithFormat:@"%@", DESC(@"oolite-keyconfig-update-title")]];
 
    [gui setArray: [NSArray arrayWithObjects: 
                                DESC(@"oolite-keyconfig-update-function"), [selected_entry objectForKey: KEY_KC_GUIDESC], nil]
                    forRow: GUI_ROW_KC_UPDATE_FUNCNAME];
    [gui setColor:[OOColor greenColor] forRow:GUI_ROW_KC_UPDATE_FUNCNAME];
 
    NSString *keystring = nil;
    NSString *keyshift = nil;
    NSString *keymod1 = nil;
    NSString *keymod2 = nil;
 
    NSDictionary *def = nil;
    NSString *key = nil;
    OOKeyCode k_int;
 
    // get each key for the first two item in the selected entry
    for (i = 0; i <= 1; i++)
    {
        keystring = DESC(@"oolite-keycode-unset");
        keyshift = DESC(@"oolite-keyconfig-modkey-off");
        keymod1 = DESC(@"oolite-keyconfig-modkey-off");
        keymod2 = DESC(@"oolite-keyconfig-modkey-off");
 
        if ([key_list count] > i)
        {
            def = [key_list objectAtIndex:i];
            key = [def objectForKey:@"key"];
            k_int = (OOKeyCode)[key integerValue];
            if (k_int > 0)
            {
                keystring = [self keyCodeDescription:k_int];
                if ([[def objectForKey:@"shift"] boolValue] == YES) keyshift = DESC(@"oolite-keyconfig-modkey-on");
                if ([[def objectForKey:@"mod1"] boolValue] == YES) keymod1 = DESC(@"oolite-keyconfig-modkey-on");
                if ([[def objectForKey:@"mod2"] boolValue] == YES) keymod2 = DESC(@"oolite-keyconfig-modkey-on");
            }
        }
 
        [self outputKeyDefinition:keystring shift:keyshift mod1:keymod1 mod2:keymod2 skiprows:(i * 5)];
    }
 
    NSString *helper = DESC(@"oolite-keyconfig-update-helper");
    if ([nav_keys containsObject:[selected_entry objectForKey: KEY_KC_DEFINITION]])
        helper = [NSString stringWithFormat:@"%@ %@", helper, DESC(@"oolite-keyconfig-update-navkeys")];
    if ([camera_keys containsObject:[selected_entry objectForKey: KEY_KC_DEFINITION]])
        helper = [NSString stringWithFormat:@"%@ %@", helper, DESC(@"oolite-keyconfig-update-camkeys")];
    [gui addLongText:helper startingAtRow:GUI_ROW_KC_UPDATE_INFO align:GUI_ALIGN_LEFT];
 
    [gui setText:@"" forRow:GUI_ROW_KC_VALIDATION];
 
    [gui setText:DESC(@"oolite-keyconfig-update-save") forRow:GUI_ROW_KC_SAVE align:GUI_ALIGN_CENTER];
    [gui setKey:GUI_KEY_OK forRow:GUI_ROW_KC_SAVE];
    
    [gui setText:DESC(@"oolite-keyconfig-update-cancel") forRow:GUI_ROW_KC_CANCEL align:GUI_ALIGN_CENTER];
    [gui setKey:GUI_KEY_OK forRow:GUI_ROW_KC_CANCEL];
 
    [gui setSelectableRange: NSMakeRange(GUI_ROW_KC_KEY, (GUI_ROW_KC_CANCEL - GUI_ROW_KC_KEY) + 1)];
 
    NSString *validate = [self validateKey:[selected_entry objectForKey:KEY_KC_DEFINITION] checkKeys:key_list];
    if (validate)
    {
        for (i = 0; i < [keyFunctions count]; i++)
        {
            if ([[[keyFunctions objectAtIndex:i] objectForKey:KEY_KC_DEFINITION] isEqualToString:validate])
            {
                [gui setText:[NSString stringWithFormat:DESC(@"oolite-keyconfig-update-validation-@"), (NSString *)[[keyFunctions objectAtIndex:i] objectForKey:KEY_KC_GUIDESC]] 
                    forRow:GUI_ROW_KC_VALIDATION align:GUI_ALIGN_CENTER];
                [gui setColor:[OOColor orangeColor] forRow:GUI_ROW_KC_VALIDATION];
                break;
            }
        }
    }
 
    if (resetSelectedRow)
    {
        [gui setSelectedRow: GUI_ROW_KC_KEY];
    }
 
    [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"paused_overlay"];
    [gui setBackgroundTextureKey:@"keyboardsettings"];
    [[UNIVERSE gameView] clearMouse];
    [[UNIVERSE gameView] clearKeys];
    if (guiChanged) [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
}

setGuiToKeyMapperScreen:

- (void) setGuiToKeyMapperScreen:

(unsigned)

skip

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                :(unsigned)skip
{
    [self setGuiToKeyMapperScreen:skip resetCurrentRow:NO];
}

setGuiToKeyMapperScreen:resetCurrentRow:

- (void) setGuiToKeyMapperScreen:		(unsigned)	skip
resetCurrentRow:		(BOOL)	resetCurrentRow

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                :(unsigned)skip resetCurrentRow:(BOOL)resetCurrentRow
{
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    NSString *kbd = [defaults oo_stringForKey:@"keyboard-code" defaultValue:@"default"];
 
    GuiDisplayGen *gui = [UNIVERSE gui];
    MyOpenGLView *gameView = [UNIVERSE gameView];
    OOGUIScreenID oldScreen = gui_screen;
    OOGUITabStop tabStop[GUI_MAX_COLUMNS];
    tabStop[0] = 10;
    tabStop[1] = 290;
    tabStop[2] = 400;
    [gui setTabStops:tabStop];
 
    if (!kdic_check) [self initCheckingDictionary];
 
    gui_screen = GUI_SCREEN_KEYBOARD;
    BOOL guiChanged = (oldScreen != gui_screen);
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:YES];
 
    [gui clear];
    [gui setTitle:[NSString stringWithFormat:@"Configure Keyboard"]];
 
    // show keyboard layout
    [gui setArray:[NSArray arrayWithObjects:DESC(@"oolite-keyconfig-keyboard"), [self keyboardDescription:kbd], nil] forRow:GUI_ROW_KC_SELECTKBD];
    [gui setKey:[NSString stringWithFormat:@"kbd:%@", kbd] forRow:GUI_ROW_KC_SELECTKBD];
    [gui setColor:[OOColor yellowColor] forRow:GUI_ROW_KC_SELECTKBD];
 
    [self displayKeyFunctionList:gui skip:skip];
 
    has_error = NO;
    if ([[self validateAllKeys] count] > 0)
    {
        has_error = YES;
        [gui setText:DESC(@"oolite-keyconfig-validation-error") forRow:GUI_ROW_KC_ERROR align:GUI_ALIGN_CENTER];
        [gui setColor:[OOColor redColor] forRow:GUI_ROW_KC_ERROR];
 
    }
    [gui setArray:[NSArray arrayWithObject:DESC(@"oolite-keyconfig-initial-info-1")] forRow:GUI_ROW_KC_INSTRUCT];
    [gui setText:DESC(@"oolite-keyconfig-initial-info-2") forRow:GUI_ROW_KC_INSTRUCT+1 align:GUI_ALIGN_CENTER];
    if (has_error)
    {
        [gui setText:DESC(@"oolite-keyconfig-initial-error") forRow:GUI_ROW_KC_INSTRUCT+2 align:GUI_ALIGN_CENTER];
    }
    else
    {
        [gui setText:DESC(@"oolite-keyconfig-initial-info-3") forRow:GUI_ROW_KC_INSTRUCT+2 align:GUI_ALIGN_CENTER];
    }
 
    if (resetCurrentRow)
    {
        int offset = 0;
        if ([[keyFunctions objectAtIndex:skip] objectForKey:KEY_KC_HEADER]) offset = 1;
        [gui setSelectedRow:GUI_ROW_KC_FUNCSTART + offset];
    }
    else 
    {
        [gui setSelectedRow:current_row];
    }
 
    [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"paused_overlay"];
    [gui setBackgroundTextureKey:@"keyboardsettings"];
 
    [gameView clearMouse];
    [gameView clearKeys];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
 
    if (guiChanged) [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
}

setGuiToLoadCommanderScreen

- (void) setGuiToLoadCommanderScreen

implementation

Provided by category PlayerEntity(OOLoadSavePrivate).

Definition at line 1420 of file PlayerEntityLoadSave.m.

{
    GuiDisplayGen *gui=[UNIVERSE gui];
    NSString*   dir = [[UNIVERSE gameController] playerFileDirectory];
    
    gui_screen = GUI_SCREEN_LOAD;
    
    [gui clear];
    [gui setTitle:DESC(@"loadscreen-title")];
    
    currentPage = 0;
    [self lsCommanders:gui directory:dir pageNumber: currentPage highlightName:nil];
    
    [gui setForegroundTextureKey:@"docked_overlay"];
    [gui setBackgroundTextureKey:@"load_save"];
    
    [[UNIVERSE gameView] suppressKeysUntilKeyUp];
    
    [self setShowDemoShips:YES];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
}

setGuiToLoadSaveScreen

- (void) setGuiToLoadSaveScreen

Definition at line 8865 of file PlayerEntity.m.

{
    BOOL            gamePaused = [[UNIVERSE gameController] isGamePaused];
    BOOL            canLoadOrSave = NO;
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    OOGUIScreenID   oldScreen = gui_screen;
    
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:YES];
 
    gui_screen = GUI_SCREEN_OPTIONS;
 
    if ([self status] == STATUS_DOCKED)
    {
        if ([self dockedStation] == nil)  [self setDockedAtMainStation];
        canLoadOrSave = (([self dockedStation] == [UNIVERSE station] || [[self dockedStation] allowsSaving]) && !([[UNIVERSE sun] goneNova] || [[UNIVERSE sun] willGoNova]));
    }
    
    BOOL canQuickSave = (canLoadOrSave && ([[gameView gameController] playerFileToLoad] != nil));
    
    // GUI stuff
    {
        GuiDisplayGen* gui = [UNIVERSE gui];
        GUI_ROW_INIT(gui);
 
        int first_sel_row = (canLoadOrSave)? GUI_ROW(,SAVE) : GUI_ROW(,GAMEOPTIONS);
        if (canQuickSave)
            first_sel_row = GUI_ROW(,QUICKSAVE);
 
        [gui clear];
        [gui setTitle:[NSString stringWithFormat:DESC(@"status-commander-@"), [self commanderName]]]; //Same title as status screen.
        
        [gui setText:DESC(@"options-quick-save") forRow:GUI_ROW(,QUICKSAVE) align:GUI_ALIGN_CENTER];
        if (canQuickSave)
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(,QUICKSAVE)];
        else
            [gui setColor:[OOColor grayColor] forRow:GUI_ROW(,QUICKSAVE)];
 
        [gui setText:DESC(@"options-save-commander") forRow:GUI_ROW(,SAVE) align:GUI_ALIGN_CENTER];
        [gui setText:DESC(@"options-load-commander") forRow:GUI_ROW(,LOAD) align:GUI_ALIGN_CENTER];
        if (canLoadOrSave)
        {
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(,SAVE)];
            [gui setKey:GUI_KEY_OK forRow:GUI_ROW(,LOAD)];
        }
        else
        {
            [gui setColor:[OOColor grayColor] forRow:GUI_ROW(,SAVE)];
            [gui setColor:[OOColor grayColor] forRow:GUI_ROW(,LOAD)];
        }
 
        [gui setText:DESC(@"options-return-to-menu") forRow:GUI_ROW(,BEGIN_NEW) align:GUI_ALIGN_CENTER];
        [gui setKey:GUI_KEY_OK forRow:GUI_ROW(,BEGIN_NEW)];
 
        [gui setText:DESC(@"options-game-options") forRow:GUI_ROW(,GAMEOPTIONS) align:GUI_ALIGN_CENTER];
        [gui setKey:GUI_KEY_OK forRow:GUI_ROW(,GAMEOPTIONS)];
        
#if OOLITE_SDL
        // GNUstep needs a quit option at present (no Cmd-Q) but
        // doesn't need speech.
        
        // quit menu option
        [gui setText:DESC(@"options-exit-game") forRow:GUI_ROW(,QUIT) align:GUI_ALIGN_CENTER];
        [gui setKey:GUI_KEY_OK forRow:GUI_ROW(,QUIT)];
#endif
        
        [gui setSelectableRange:NSMakeRange(first_sel_row, GUI_ROW_OPTIONS_END_OF_LIST)];
 
        if (gamePaused || (!canLoadOrSave && [self status] == STATUS_DOCKED))
        {
            [gui setSelectedRow: GUI_ROW(,GAMEOPTIONS)];
        }
        else
        {
            [gui setSelectedRow: first_sel_row];
        }
        
        [gui setShowTextCursor:NO];
        
        if ([gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"paused_overlay"] && [UNIVERSE pauseMessageVisible])
                    [[UNIVERSE messageGUI] clear];
        // Graphically, this screen is analogous to the various settings screens
        [gui setBackgroundTextureKey:@"settings"];
    }
    /* ends */
    
    [[UNIVERSE gameView] clearMouse];
    
    [self setShowDemoShips:NO];
    
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
    
    if (gamePaused)
    {
        [[UNIVERSE messageGUI] clear]; 
        NSString *pauseKey = [PLAYER keyBindingDescription2:@"key_pausebutton"];
        [UNIVERSE addMessage:OOExpandKey(@"game-paused-docked", pauseKey) forCount:1.0 forceDisplay:YES];
    }
    
    [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
}

setGuiToLongRangeChartScreen

- (void) setGuiToLongRangeChartScreen

Definition at line 13727 of file PlayerEntity.m.

{
    OOGUIScreenID   oldScreen = gui_screen;
    GuiDisplayGen   *gui = [UNIVERSE gui];
    [gui clearAndKeepBackground:NO];
    [gui setBackgroundTextureKey:@"short_range_chart"];
    [self setMissionBackgroundSpecial: nil];
    gui_screen = GUI_SCREEN_LONG_RANGE_CHART;
    target_chart_zoom = CHART_MAX_ZOOM;
    [self setGuiToChartScreenFrom: oldScreen];
}

setGuiToManifestScreen

- (void) setGuiToManifestScreen

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

{
    OOGUIScreenID   oldScreen = gui_screen;
    
    GuiDisplayGen   *gui = [UNIVERSE gui];
    gui_screen = GUI_SCREEN_MANIFEST;
    BOOL            guiChanged = (oldScreen != gui_screen);
    if (guiChanged)
    {
        [gui setStatusPage:0]; // need to do this earlier than the rest
    }
    
    // GUI stuff
    {
        NSInteger current, max;
        OOColor *subheadColor = [gui colorFromSetting:kGuiManifestSubheadColor defaultValue:[OOColor greenColor]];
        OOColor *entryColor = [gui colorFromSetting:kGuiManifestEntryColor defaultValue:nil];
        OOColor *scrollColor = [gui colorFromSetting:kGuiManifestScrollColor defaultValue:[OOColor greenColor]];
        OOColor *noScrollColor = [gui colorFromSetting:kGuiManifestNoScrollColor defaultValue:[OOColor darkGrayColor]];
 
        NSArray*    cargoManifest = [self cargoList];
        NSArray*    missionsManifest = [self missionsList];
        
        NSUInteger  i = 0;
        NSUInteger  max_rows = 20;
        NSUInteger  manifestCount = [cargoManifest count];
        NSUInteger  cargoRowCount = (manifestCount + 1)/2;
        OOGUIRow    cargoRow = 2;
        OOGUIRow    missionsRow = 2;
        
        OOGUIRow    nextPageRow = MANIFEST_SCREEN_ROW_NEXT;
        // show extra lines if no HUD is displayed.
        if ([[self hud] isHidden] || [[self hud] allowBigGui])
        {
            max_rows += 7;
            nextPageRow += 7;
        }
 
        NSUInteger mmRows = 0;
        id mmEntry = nil;
        foreach (mmEntry, missionsManifest)
        {
            if ([mmEntry isKindOfClass:[NSString class]])
            {
                ++mmRows;
            }
            else if ([mmEntry isKindOfClass:[NSArray class]])
            {
                mmRows += [(NSArray *)mmEntry count];
            }
        }
        
        NSInteger page_offset = 0;
        BOOL multi_page = NO;
//      NSUInteger total_rows = cargoRowCount + MAX(1U,[passengerManifest count]) + MAX(1U,[contractManifest count]) + mmRows + MAX(1U,[parcelManifest count]) + 5;
        NSUInteger total_rows = cargoRowCount + mmRows + 5;
        if (total_rows > max_rows)
        {
            max_rows -= 2;
            page_offset = ([gui statusPage]-1) * max_rows;
            if (page_offset < 0 || (NSUInteger)page_offset >= total_rows)
            {
                [gui setStatusPage:0];
                page_offset = 0;
            }
            multi_page = YES;
        }
 
 
        OOGUITabSettings tab_stops;
        tab_stops[0] = 0;
        tab_stops[1] = 256;
        [gui overrideTabs:tab_stops from:kGuiManifestTabs length:3];
        [gui setTabStops:tab_stops];
        
        // Cargo Manifest
        current_cargo = [self cargoQuantityOnBoard];
 
        [gui clearAndKeepBackground:!guiChanged];
        [gui setTitle:DESC(@"manifest-title")];
        
        current = current_cargo;
        max = [self maxAvailableCargoSpace];
        NSString *cargoString = OOExpandKey(@"oolite-manifest-cargo", current, max);
        current = [[self passengerList] count];
        max = max_passengers;
        NSString *cabinString = OOExpandKey(@"oolite-manifest-cabins", current, max);
        NSArray *manifestHeader = [NSArray arrayWithObjects:cargoString,cabinString,nil];
 
        SET_MANIFEST_ROW( manifestHeader , entryColor, cargoRow - 1);
        
        if (manifestCount > 0)
        {
            for (i = 0; i < cargoRowCount; i++)
            {
                NSMutableArray*     row_info = [NSMutableArray arrayWithCapacity:3];
                // i is always smaller than manifest_count, no need to test.
                [row_info addObject:[cargoManifest objectAtIndex:i]];
                if (i + cargoRowCount < manifestCount)
                {
                    [row_info addObject:[cargoManifest objectAtIndex:i + cargoRowCount]];
                }
                else
                {
                    [row_info addObject:@""];
                }
                SET_MANIFEST_ROW( (NSArray *)row_info, subheadColor, cargoRow + i);
            }
        }
        else
        {
            SET_MANIFEST_ROW( (DESC(@"manifest-none")), subheadColor, cargoRow);
            cargoRowCount=1;
        }
        
        missionsRow = cargoRow + cargoRowCount + 1;
        
        // Missions Manifest
        manifestCount = [missionsManifest count];
        
        if (manifestCount > 0)
        {
            if ([[missionsManifest objectAtIndex:0] isKindOfClass:[NSString class]])
            {
                // then there's at least one without its own heading
                // to go under the generic 'missions' heading
                SET_MANIFEST_ROW( (DESC(@"manifest-missions")) , entryColor, missionsRow - 1);
            }
            else
            {
                missionsRow--;
            }
            
            NSUInteger mmRow = 0;
            for (i = 0; i < manifestCount; i++)
            {
                NSString *mmItem = nil;
                mmEntry = [missionsManifest objectAtIndex:i];
                if ([mmEntry isKindOfClass:[NSString class]])
                {
                    mmItem = [NSString stringWithFormat:@"\t%@",(NSString *)mmEntry];
                    SET_MANIFEST_ROW( (mmItem) , subheadColor, missionsRow + mmRow);
                    ++mmRow;
                }
                else if ([mmEntry isKindOfClass:[NSArray class]])
                {
                    BOOL isHeading = YES;
                    foreach (mmItem, mmEntry)
                    {
                        if (isHeading)
                        {
                            SET_MANIFEST_ROW( ((NSString *)mmItem) , entryColor , missionsRow + mmRow);
                        }
                        else
                        {
                            mmItem = [NSString stringWithFormat:@"\t%@",(NSString *)mmItem];
                            SET_MANIFEST_ROW( ((NSString *)mmItem) , subheadColor , missionsRow + mmRow);
                        }
                        isHeading = NO;
                        ++mmRow;
                    }
                }
            }
        }
        
        if (multi_page)
        {
            OOGUIRow r_start = MANIFEST_SCREEN_ROW_BACK;
            OOGUIRow r_end = nextPageRow;
            if (page_offset > 0)
            {
                [gui setColor:scrollColor forRow:MANIFEST_SCREEN_ROW_BACK];
                [gui setKey:GUI_KEY_OK forRow:MANIFEST_SCREEN_ROW_BACK];
            }
            else
            {
                [gui setColor:noScrollColor forRow:MANIFEST_SCREEN_ROW_BACK];
                r_start = nextPageRow;
            }
            [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-back"), @" <-- ",nil] forRow:MANIFEST_SCREEN_ROW_BACK];
 
            if (total_rows > max_rows + page_offset)
            {
                [gui setColor:scrollColor forRow:nextPageRow];
                [gui setKey:GUI_KEY_OK forRow:nextPageRow];
            }
            else
            {
                [gui setColor:noScrollColor forRow:nextPageRow];
                r_end = MANIFEST_SCREEN_ROW_BACK;
            }
            [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-more"), @" --> ",nil] forRow:nextPageRow];
 
            [gui setSelectableRange:NSMakeRange(r_start,r_end+1-r_start)];
            [gui setSelectedRow:r_start];
 
        }
 
        [gui setShowTextCursor:NO];
    }
    /* ends */
    
    if (lastTextKey)
    {
        [lastTextKey release];
        lastTextKey = nil;
    }
    
    [self setShowDemoShips:NO];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO];
    
    if (guiChanged)
    {
        [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"overlay"];
        [gui setBackgroundTextureKey:@"manifest"];
        [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
    }
}

setGuiToMarketInfoScreen

- (void) setGuiToMarketInfoScreen

Definition at line 9242 of file PlayerEntity.m.

{
    OOCommodityMarket   *localMarket = [self localMarket];
    GuiDisplayGen       *gui = [UNIVERSE gui];
    OOGUIScreenID       oldScreen = gui_screen;
    
    gui_screen = GUI_SCREEN_MARKETINFO;
    BOOL            guiChanged = (oldScreen != gui_screen);
 
    
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:YES];
    
    // fix problems with economies in witchspace
    if (localMarket == nil)
    {
        localMarket = [[UNIVERSE commodities] generateBlankMarket];
    }
 
    // following changed to work whether docked or not
    NSArray             *goods = [self applyMarketSorter:[self applyMarketFilter:[localMarket goods] onMarket:localMarket] onMarket:localMarket];
 
    NSUInteger          i, j, commodityCount = [shipCommodityData count];
    OOCargoQuantity     quantityInHold[commodityCount];
        
    for (i = 0; i < commodityCount; i++)
    {
        quantityInHold[i] = [shipCommodityData quantityForGood:[goods oo_stringAtIndex:i]];
    }
    for (i = 0; i < [cargo count]; i++)
    {
        ShipEntity *container = [cargo objectAtIndex:i];
        j = [goods indexOfObject:[container commodityType]];
        quantityInHold[j] += [container commodityAmount];
    }
 
 
    // GUI stuff
    {
        if (EXPECT_NOT(marketSelectedCommodity == nil))
        {
            j = NSNotFound;
        }
        else
        {
            j = [goods indexOfObject:marketSelectedCommodity];
        }
        if (j == NSNotFound)
        {
            DESTROY(marketSelectedCommodity);
            [self setGuiToMarketScreen];
            return;
        }
 
        [gui clearAndKeepBackground:!guiChanged];
 
        [gui setTitle:[NSString stringWithFormat:DESC(@"oolite-commodity-information-@"), [shipCommodityData nameForGood:marketSelectedCommodity]]];
 
        [self showMarketScreenHeaders];
        [self showMarketScreenDataLine:GUI_ROW_MARKET_START forGood:marketSelectedCommodity inMarket:localMarket holdQuantity:quantityInHold[j]];
 
        OOCargoQuantity contracted = [self contractedVolumeForGood:marketSelectedCommodity];
        if (contracted > 0)
        {
            OOMassUnit unit = [shipCommodityData massUnitForGood:marketSelectedCommodity];
            [gui setColor:[gui colorFromSetting:kGuiMarketContractedColor defaultValue:nil] forRow:GUI_ROW_MARKET_START+1];
            [gui setText:[NSString stringWithFormat:DESC(@"oolite-commodity-contracted-d-@"), contracted, DisplayStringForMassUnit(unit)] forRow:GUI_ROW_MARKET_START+1];
        }
 
        NSString *info = [shipCommodityData commentForGood:marketSelectedCommodity];
        OOGUIRow i = 0;
        if (info == nil || [info length] == 0)
        {
            i = [gui addLongText:DESC(@"oolite-commodity-no-comment") startingAtRow:GUI_ROW_MARKET_START+2 align:GUI_ALIGN_LEFT];
        }
        else
        {
            i = [gui addLongText:info startingAtRow:GUI_ROW_MARKET_START+2 align:GUI_ALIGN_LEFT];
        }
        for (i-- ; i > GUI_ROW_MARKET_START+2 ; --i)
        {
            [gui setColor:[gui colorFromSetting:kGuiMarketDescriptionColor defaultValue:nil] forRow:i];
        }
 
        [self showMarketCashAndLoadLine];
 
    }
 
    [[UNIVERSE gameView] clearMouse];
    
    [self setShowDemoShips:NO];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
    
    if (guiChanged)
    {
        [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"overlay"];
        [gui setBackgroundTextureKey:@"marketinfo"];
        [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
    }
}

setGuiToMarketScreen

- (void) setGuiToMarketScreen

Definition at line 9242 of file PlayerEntity.m.

{
    OOCommodityMarket   *localMarket = [self localMarket];
    GuiDisplayGen       *gui = [UNIVERSE gui];
    OOGUIScreenID       oldScreen = gui_screen;
    
    gui_screen = GUI_SCREEN_MARKET;
    BOOL            guiChanged = (oldScreen != gui_screen);
 
    
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:YES];
    
    // fix problems with economies in witchspace
    if (localMarket == nil)
    {
        localMarket = [[UNIVERSE commodities] generateBlankMarket];
    }
 
    // following changed to work whether docked or not
    NSArray *goods = [self applyMarketSorter:[self applyMarketFilter:[localMarket goods] onMarket:localMarket] onMarket:localMarket];
    NSInteger maxOffset = 0;
    if ([goods count] > (GUI_ROW_MARKET_END-GUI_ROW_MARKET_START))
    {
        maxOffset = [goods count]-(GUI_ROW_MARKET_END-GUI_ROW_MARKET_START);
    }
 
    NSUInteger          commodityCount = [shipCommodityData count];
    OOCargoQuantity     quantityInHold[commodityCount];
        
    for (NSUInteger i = 0; i < commodityCount; i++)
    {
        quantityInHold[i] = [shipCommodityData quantityForGood:[goods oo_stringAtIndex:i]];
    }
    for (NSUInteger i = 0; i < [cargo count]; i++)
    {
        ShipEntity *container = [cargo objectAtIndex:i];
        NSUInteger goodsIndex = [goods indexOfObject:[container commodityType]];
        // can happen with filters
        if (goodsIndex != NSNotFound)
        {
            quantityInHold[goodsIndex] += [container commodityAmount];
        }
    }
 
    if (marketSelectedCommodity != nil && ([marketSelectedCommodity isEqualToString:@"<<<"] || [marketSelectedCommodity isEqualToString:@">>>"]))
    {
        // nothing?
    }
    else
    {
        if (marketSelectedCommodity == nil || [goods indexOfObject:marketSelectedCommodity] == NSNotFound)
        {
            DESTROY(marketSelectedCommodity);
            if ([goods count] > 0)
            {
                marketSelectedCommodity = [[goods oo_stringAtIndex:0] retain];
            }
        }
        if (maxOffset > 0)
        {
            NSInteger goodsIndex = [goods indexOfObject:marketSelectedCommodity];
            // validate marketOffset when returning from infoscreen
            if (goodsIndex <= marketOffset)
            {
                // is off top of list, move list upwards
                if (goodsIndex == 0) {
                    marketOffset = 0;
                } else {
                    marketOffset = goodsIndex-1;
                }
            }
            else if (goodsIndex > marketOffset+(GUI_ROW_MARKET_END-GUI_ROW_MARKET_START)-2)
            {
                // is off bottom of list, move list downwards
                marketOffset = 2+goodsIndex-(GUI_ROW_MARKET_END-GUI_ROW_MARKET_START);
                if (marketOffset > maxOffset)
                {
                    marketOffset = maxOffset;
                }
            }
        }
    }
 
    // GUI stuff
    {
        OOGUIRow            start_row = GUI_ROW_MARKET_START;
        OOGUIRow            row = start_row;
        OOGUIRow            active_row = [gui selectedRow];
 
        [gui clearAndKeepBackground:!guiChanged];
        
        
        StationEntity *dockedStation = [self dockedStation];
        if (dockedStation == nil && [[self primaryTarget] isStation] && [(StationEntity *)[self primaryTarget] marketBroadcast])
        {
            dockedStation = [self primaryTarget];
        }
 
        [gui setTitle:[self marketScreenTitle]];
        
        [self showMarketScreenHeaders];
 
        if (marketOffset > maxOffset)
        {
            marketOffset = 0;
        }
        else if (marketOffset < 0)
        {
            marketOffset = maxOffset;
        }
 
        if ([goods count] > 0)
        {
            OOCommodityType good = nil;
            NSInteger i = 0;
            foreach (good, goods)
            {
                if (i < marketOffset)
                {
                    ++i;
                    continue;
                }
                [self showMarketScreenDataLine:row forGood:good inMarket:localMarket holdQuantity:quantityInHold[i++]];
                if ([good isEqualToString:marketSelectedCommodity])
                {
                    active_row = row;
                }
 
                ++row;
                if (row >= GUI_ROW_MARKET_END)
                {
                    break;
                }
            }
 
            if (marketOffset < maxOffset)
            {
                if ([marketSelectedCommodity isEqualToString:@">>>"])
                {
                    active_row = GUI_ROW_MARKET_LAST;
                }
                [gui setKey:@">>>" forRow:GUI_ROW_MARKET_LAST];
                [gui setColor:[gui colorFromSetting:kGuiMarketScrollColor defaultValue:[OOColor greenColor]] forRow:GUI_ROW_MARKET_LAST];
                [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-more"), @"", @"", @"", @" --> ", nil] forRow:GUI_ROW_MARKET_LAST];
            }
            if (marketOffset > 0)
            {
                if ([marketSelectedCommodity isEqualToString:@"<<<"])
                {
                    active_row = GUI_ROW_MARKET_START;
                }
                [gui setKey:@"<<<" forRow:GUI_ROW_MARKET_START];
                [gui setColor:[gui colorFromSetting:kGuiMarketScrollColor defaultValue:[OOColor greenColor]] forRow:GUI_ROW_MARKET_START];
                [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-back"), @"", @"", @"", @" <-- ", nil] forRow:GUI_ROW_MARKET_START];
            }
        }
        else
        {
            // filter is excluding everything
            [gui setColor:[gui colorFromSetting:kGuiMarketFilteredAllColor defaultValue:[OOColor yellowColor]] forRow:GUI_ROW_MARKET_START];
            [gui setText:DESC(@"oolite-market-filtered-all") forRow:GUI_ROW_MARKET_START];
            active_row = -1;
        }
 
         // actually count the containers and  valuables (may be > max_cargo)
        current_cargo = [self cargoQuantityOnBoard];
        if (current_cargo > [self maxAvailableCargoSpace]) current_cargo = [self maxAvailableCargoSpace]; 
 
        // filter sort info
        {
            NSString *filterMode = OOExpandKey(OOExpand(@"oolite-market-filter-[marketFilterMode]", marketFilterMode));
            NSString *filterText = OOExpandKey(@"oolite-market-filter-line", filterMode);
            NSString *sortMode = OOExpandKey(OOExpand(@"oolite-market-sorter-[marketSorterMode]", marketSorterMode));
            NSString *sorterText = OOExpandKey(@"oolite-market-sorter-line", sortMode);
            [gui setArray:[NSArray arrayWithObjects:filterText, @"", sorterText, nil] forRow:GUI_ROW_MARKET_END];
        }
        [gui setColor:[gui colorFromSetting:kGuiMarketFilterInfoColor defaultValue:[OOColor greenColor]] forRow:GUI_ROW_MARKET_END];
 
        [self showMarketCashAndLoadLine];
        
        [gui setSelectableRange:NSMakeRange(start_row,row - start_row)];
        [gui setSelectedRow:active_row];
        
        [gui setShowTextCursor:NO];
    }
 
    
    [[UNIVERSE gameView] clearMouse];
    
    [self setShowDemoShips:NO];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
    
    if (guiChanged)
    {
        [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"overlay"];
        [gui setBackgroundTextureKey:@"market"];
        [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
    }
}

setGuiToMissionEndScreen

- (void) setGuiToMissionEndScreen

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    [gameView clearKeys];
    if ([self status] != STATUS_DOCKED)
    {
        // this setting is only applied when not docked
        [self setGuiToStatusScreen];
        return;
    }
    switch (_missionExitScreen)
    {
    case GUI_SCREEN_MANIFEST:
        [self noteGUIWillChangeTo:GUI_SCREEN_MANIFEST];
        [self setGuiToManifestScreen];
        break;
    case GUI_SCREEN_EQUIP_SHIP:
        [self noteGUIWillChangeTo:GUI_SCREEN_EQUIP_SHIP];
        [self setGuiToEquipShipScreen:0];
        break;
    case GUI_SCREEN_SHIPYARD:
        if ([[self dockedStation] hasShipyard])
        {
            [self noteGUIWillChangeTo:GUI_SCREEN_SHIPYARD];
            [self setGuiToShipyardScreen:0];
            [[UNIVERSE gui] setSelectedRow:GUI_ROW_SHIPYARD_START];
            [self showShipyardInfoForSelection];
        }
        else
        {
            // that doesn't work here
            [self setGuiToStatusScreen];
        }
        break;
    case GUI_SCREEN_LONG_RANGE_CHART:
        [self setGuiToLongRangeChartScreen];
        break;
    case GUI_SCREEN_SHORT_RANGE_CHART:
        [self setGuiToShortRangeChartScreen];
        break;
    case GUI_SCREEN_SYSTEM_DATA:
        [self noteGUIWillChangeTo:GUI_SCREEN_SYSTEM_DATA];
        [self setGuiToSystemDataScreen];
        break;
    case GUI_SCREEN_MARKET:
        [self noteGUIWillChangeTo:GUI_SCREEN_MARKET];
        [self setGuiToMarketScreen];
        break;
    case GUI_SCREEN_MARKETINFO:
        [self noteGUIWillChangeTo:GUI_SCREEN_MARKETINFO];
        [self setGuiToMarketInfoScreen];
        break;
    case GUI_SCREEN_INTERFACES:
        [self setGuiToInterfacesScreen:0];
        break;
    case GUI_SCREEN_STATUS:
    default: // invalid screen specifications
        [self setGuiToStatusScreen];
    }
}

setGuiToMissionScreen

- (void) setGuiToMissionScreen

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    // reset special background as legacy scripts can't use it, and this
    // is only called by legacy scripts
    [self setMissionBackgroundSpecial:nil];
    // likewise exit screen target
    [self setMissionExitScreen:GUI_SCREEN_STATUS];
 
    [self setGuiToMissionScreenWithCallback:NO];
}

setGuiToMissionScreenWithCallback:

- (void) setGuiToMissionScreenWithCallback:

(BOOL)

callback

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                                          :(BOOL) callback
{
    GuiDisplayGen   *gui = [UNIVERSE gui];
    OOGUIScreenID   oldScreen = gui_screen;
    NSUInteger end_row = 21;
    if ([[self hud] allowBigGui]) 
    {
        end_row = 27;
    }
 
    // GUI stuff
    {
        [gui clear];
        [gui setTitle:[self missionTitle] ?: DESC(@"mission-information")];
        
        if (!_missionTextEntry)
        {
            [gui setText:DESC(@"press-space-commander") forRow:end_row align:GUI_ALIGN_CENTER];
            [gui setColor:[OOColor yellowColor] forRow:end_row];
            [gui setKey:@"spacebar" forRow:end_row];
            [gui setShowTextCursor:NO];
        }
        else
        {
            [self refreshMissionScreenTextEntry];
        }
        [gui setSelectableRange:NSMakeRange(0,0)];
        
        [gui setForegroundTextureDescriptor:[self missionOverlayDescriptorOrDefault]];
        NSDictionary *background_desc = [self missionBackgroundDescriptorOrDefault];
        [gui setBackgroundTextureDescriptor:background_desc];
        // must set special second as setting the descriptor resets it
        BOOL overridden = ([self missionBackgroundDescriptor] != nil);
        [gui setBackgroundTextureSpecial:[self missionBackgroundSpecial] withBackground:!overridden];
        
 
    }
    /* ends */
 
    missionTextRow = 1;
 
    
    if (gui)
        gui_screen = GUI_SCREEN_MISSION;
 
    if (lastTextKey)
    {
        [lastTextKey release];
        lastTextKey = nil;
    }
    
    [[OOMusicController sharedController] playMissionMusic];
    
    // the following are necessary...
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO];
    _missionWithCallback = callback;
    _missionAllowInterrupt = NO;
    [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
 
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setGuiToOverwriteScreen:

- (void) setGuiToOverwriteScreen: (NSString *)  cdrName

implementation

Provided by category PlayerEntity(OOLoadSavePrivate).

Definition at line 1420 of file PlayerEntityLoadSave.m.

                                :(NSString *)cdrName
{
    GuiDisplayGen *gui=[UNIVERSE gui];
    MyOpenGLView*   gameView = [UNIVERSE gameView];
    
    // Don't poll controls
    pollControls=NO;
    
    gui_screen = GUI_SCREEN_SAVE_OVERWRITE;
    
    [gui clear];
    [gui setTitle:[NSString stringWithFormat:DESC(@"overwrite-save-commander-@"), cdrName]];
    
    [gui setText:[NSString stringWithFormat:DESC(@"overwritescreen-commander-@-already-exists-overwrite-query"), cdrName]
                                forRow:SAVE_OVERWRITE_WARN_ROW align: GUI_ALIGN_CENTER];
    
    [gui setText:DESC(@"overwritescreen-yes") forRow: SAVE_OVERWRITE_YES_ROW align: GUI_ALIGN_CENTER];
    [gui setKey:GUI_KEY_OK forRow: SAVE_OVERWRITE_YES_ROW];
    
    [gui setText:DESC(@"overwritescreen-no") forRow: SAVE_OVERWRITE_NO_ROW align: GUI_ALIGN_CENTER];
    [gui setKey:GUI_KEY_OK forRow: SAVE_OVERWRITE_NO_ROW];
    
    [gui setSelectableRange: NSMakeRange(SAVE_OVERWRITE_YES_ROW, 2)];
    [gui setSelectedRow: SAVE_OVERWRITE_NO_ROW];
    
    // We can only leave this screen by answering yes or no, or esc. Therefore
    // use a specific overlay, to allow visual reminders of the available options.
    [gui setForegroundTextureKey:@"overwrite_overlay"];
    [gui setBackgroundTextureKey:@"load_save"];
    
    [self setShowDemoShips:NO];
    [gameView setStringInput:gvStringInputNo];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO]; // FIXME: should be YES, but was NO before introducing new mouse mode stuff. If set to YES, choices can be selected but not activated.
}

setGuiToOXZManager

- (void) setGuiToOXZManager

Definition at line 9242 of file PlayerEntity.m.

{
 
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:NO];
    [[UNIVERSE gameView] clearMouse];
    [UNIVERSE removeDemoShips];
 
    gui_screen = GUI_SCREEN_OXZMANAGER;
 
    [[UNIVERSE gui] clearAndKeepBackground:NO];
 
    [[OOOXZManager sharedManager] gui];
    
    [[OOMusicController sharedController] playThemeMusic];
    [[UNIVERSE gui] setBackgroundTextureKey:@"oxz-manager"];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
}

setGuiToSaveCommanderScreen:

- (void) setGuiToSaveCommanderScreen: (NSString *)  cdrName

implementation

Provided by category PlayerEntity(OOLoadSavePrivate).

Definition at line 1420 of file PlayerEntityLoadSave.m.

                                    :(NSString *)cdrName
{
    GuiDisplayGen *gui=[UNIVERSE gui];
    MyOpenGLView *gameView = [UNIVERSE gameView];
    NSString *dir = [[UNIVERSE gameController] playerFileDirectory];
    
    pollControls = NO;
    gui_screen = GUI_SCREEN_SAVE;
    
    [gui clear];
    [gui setTitle:DESC(@"savescreen-title")];
    
    currentPage = 0;
    [self lsCommanders:gui directory:dir pageNumber: currentPage highlightName:nil];
    
    [gui setText:DESC(@"savescreen-commander-name") forRow: INPUTROW];
    [gui setColor:[OOColor cyanColor] forRow:INPUTROW];
    [gui setShowTextCursor: YES];
    [gui setCurrentRow: INPUTROW];
    
    [gui setForegroundTextureKey:@"docked_overlay"];
    [gui setBackgroundTextureKey:@"load_save"];
    
    [gameView setTypedString:cdrName];
    [gameView suppressKeysUntilKeyUp];
    
    [self setShowDemoShips:YES];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
}

setGuiToScenarioScreen:

- (void) setGuiToScenarioScreen:

(int)

page

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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_screen = GUI_SCREEN_NEWGAME;
 
        [gui setSelectableRange:NSMakeRange(start_row - 2,3 + row - start_row)];
        [gui setSelectedRow:start_row];
        [self showScenarioDetails];
    
        if (guiChanged)
        {
            [gui setBackgroundTextureKey:@"newgame"];
            [gui setForegroundTextureKey:@"newgame_overlay"];
        }
    }
    
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
}

setGuiToShipyardScreen:

- (void) setGuiToShipyardScreen:

(NSUInteger)

skip

Provided by category PlayerEntity(Contracts).

Definition at line 1443 of file PlayerEntityContracts.m.

                               :(NSUInteger)skip
{
    OOGUIScreenID   oldScreen = gui_screen;
    
    GuiDisplayGen   *gui = [UNIVERSE gui];
    gui_screen = GUI_SCREEN_SHIPYARD;
    BOOL            guiChanged = (oldScreen != gui_screen); 
    
    unsigned        i;
    
    // set up initial market if there is none
    OOTechLevelID stationTechLevel;
    StationEntity *station = [self dockedStation];
    
    if (station != nil)
    {
        stationTechLevel = [station equivalentTechLevel];
    }
    else
    {
        station  = [UNIVERSE station];
        stationTechLevel = NSNotFound;
    }
    if ([station localShipyard] == nil)
    {
        [station generateShipyard:stationTechLevel];
    }
        
    NSMutableArray *shipyard = [station localShipyard];
        
    [currentShipyard release];
    currentShipyard = [[NSMutableDictionary alloc] initWithCapacity:[shipyard count]];
 
    for (i = 0; i < [shipyard count]; i++)
    {
        [currentShipyard setObject:[shipyard objectAtIndex:i]
                            forKey:[[shipyard oo_dictionaryAtIndex:i] oo_stringForKey:SHIPYARD_KEY_ID]];
    }
    
    NSUInteger shipCount = [shipyard count];
 
    //error check
    if (skip >= shipCount)  skip = shipCount - 1;
    if (skip < 2)  skip = 0;
    
    // GUI stuff
    {
        [gui clearAndKeepBackground:!guiChanged];
        NSString *system = [UNIVERSE getSystemName:system_id];
        [gui setTitle:OOExpandKey(@"shipyard-title", system)];
        
        OOGUITabSettings tab_stops;
        tab_stops[0] = 0;
        tab_stops[1] = -258;
        tab_stops[2] = 270;
        tab_stops[3] = 370;
        tab_stops[4] = 450;
        [gui overrideTabs:tab_stops from:kGuiShipyardTabs length:5];
        [gui setTabStops:tab_stops];
        
        int rowCount = MAX_ROWS_SHIPS_FOR_SALE;
        int startRow = GUI_ROW_SHIPYARD_START;
        NSInteger previous = 0;
        
        if (shipCount <= MAX_ROWS_SHIPS_FOR_SALE)
            skip = 0;
        else
        {
            if (skip > 0)
            {
                rowCount -= 1;
                startRow += 1;
                previous = skip - MAX_ROWS_SHIPS_FOR_SALE + 2;
                if (previous < 2)
                    previous = 0;
            }
            if (skip + rowCount < shipCount)
                rowCount -= 1;
        }
        
        if (shipCount > 0)
        {
            [gui setColor:[gui colorFromSetting:kGuiShipyardHeadingColor defaultValue:[OOColor greenColor]] forRow:GUI_ROW_SHIPYARD_LABELS];
            [gui setArray:[NSArray arrayWithObjects:DESC(@"shipyard-shiptype"), DESC(@"shipyard-price-label"),
                    DESC(@"shipyard-cargo-label"), DESC(@"shipyard-speed-label"), nil] forRow:GUI_ROW_SHIPYARD_LABELS];
 
            if (skip > 0)
            {
                [gui setColor:[gui colorFromSetting:kGuiShipyardScrollColor defaultValue:[OOColor greenColor]] forRow:GUI_ROW_SHIPYARD_START];
                [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-back"), @" <-- ", nil] forRow:GUI_ROW_SHIPYARD_START];
                [gui setKey:[NSString stringWithFormat:@"More:%lld", previous] forRow:GUI_ROW_SHIPYARD_START];
            }
            for (i = 0; i < (shipCount - skip) && (int)i < rowCount; i++)
            {
                NSDictionary* ship_info = [shipyard oo_dictionaryAtIndex:i + skip];
                OOCreditsQuantity ship_price = [ship_info oo_unsignedLongLongForKey:SHIPYARD_KEY_PRICE];
                [gui setColor:[gui colorFromSetting:kGuiShipyardEntryColor defaultValue:nil] forRow:startRow + i];
                [gui setArray:[NSArray arrayWithObjects:
                        [NSString stringWithFormat:@" %@ ",[[ship_info oo_dictionaryForKey:SHIPYARD_KEY_SHIP] oo_stringForKey:@"display_name" defaultValue:[[ship_info oo_dictionaryForKey:SHIPYARD_KEY_SHIP] oo_stringForKey:KEY_NAME]]],
                        OOIntCredits(ship_price),
                        nil]
                    forRow:startRow + i];
                [gui setKey:(NSString*)[ship_info objectForKey:SHIPYARD_KEY_ID] forRow:startRow + i];
            }
            if (i < shipCount - skip)
            {
                [gui setColor:[gui colorFromSetting:kGuiShipyardScrollColor defaultValue:[OOColor greenColor]] forRow:startRow + i];
                [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-more"), @" --> ", nil] forRow:startRow + i];
                [gui setKey:[NSString stringWithFormat:@"More:%llu", rowCount + skip] forRow:startRow + i];
                i++;
            }
 
            [gui setSelectableRange:NSMakeRange( GUI_ROW_SHIPYARD_START, i + startRow - GUI_ROW_SHIPYARD_START)];
            // ensure that at least one row is selected at all times
            if(shipCount == 1)  [gui setFirstSelectableRow];
            [self showShipyardInfoForSelection];
        }
        else
        {
            [gui setText:DESC(@"shipyard-no-ships-available-for-purchase") forRow:GUI_ROW_NO_SHIPS align:GUI_ALIGN_CENTER];
            [gui setColor:[gui colorFromSetting:kGuiShipyardNoshipColor defaultValue:[OOColor greenColor]] forRow:GUI_ROW_NO_SHIPS];
            
            [gui setNoSelectedRow];
        }
        
        [self showTradeInInformationFooter];
        
        [gui setShowTextCursor:NO];
    }
    
    // the following are necessary...
 
    [self setShowDemoShips:(shipCount > 0)];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
    
    if (guiChanged)
    {
        [gui setForegroundTextureKey:@"docked_overlay"];
        [gui setBackgroundTextureKey:@"shipyard"];
    }
}

setGuiToShortRangeChartScreen

- (void) setGuiToShortRangeChartScreen

Definition at line 13727 of file PlayerEntity.m.

{
    OOGUIScreenID   oldScreen = gui_screen;
    GuiDisplayGen   *gui = [UNIVERSE gui];
    [gui clearAndKeepBackground:NO];
    [gui setBackgroundTextureKey:@"short_range_chart"];
    [self setMissionBackgroundSpecial: nil];
    gui_screen = GUI_SCREEN_SHORT_RANGE_CHART;
    [self setGuiToChartScreenFrom: oldScreen];
}

setGuiToStatusScreen

- (void) setGuiToStatusScreen

Definition at line 13727 of file PlayerEntity.m.

{
    NSString        *systemName = nil;
    NSString        *targetSystemName = nil;
    NSString        *text = nil;
    
    GuiDisplayGen   *gui = [UNIVERSE gui];
    OOGUIScreenID   oldScreen = gui_screen;
    if (oldScreen != GUI_SCREEN_STATUS)
    {
        [self noteGUIWillChangeTo:GUI_SCREEN_STATUS];
    }
 
    gui_screen = GUI_SCREEN_STATUS;
    BOOL            guiChanged = (oldScreen != gui_screen);
    
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:NO];
    
    // Both system_seed & target_system_seed are != nil at all times when this function is called.
    
    systemName = [UNIVERSE inInterstellarSpace] ? DESC(@"interstellar-space") : [UNIVERSE getSystemName:system_id];
    if ([self isDocked] && [self dockedStation] != [UNIVERSE station])
    {
        systemName = [NSString stringWithFormat:@"%@ : %@", systemName, [[self dockedStation] displayName]];
    }
 
    targetSystemName =  [UNIVERSE getSystemName:target_system_id];
    NSDictionary *systemInfo = [[UNIVERSE systemManager] getPropertiesForSystem:target_system_id inGalaxy:galaxy_number];
    NSInteger concealment = [systemInfo oo_intForKey:@"concealment" defaultValue:OO_SYSTEMCONCEALMENT_NONE];
    if (concealment >= OO_SYSTEMCONCEALMENT_NONAME) targetSystemName = DESC(@"status-unknown-system");
 
    OOSystemID nextHop = [self nextHopTargetSystemID];
    if (nextHop != target_system_id) {
        NSString *nextHopSystemName = [UNIVERSE getSystemName:nextHop];
        systemInfo = [[UNIVERSE systemManager] getPropertiesForSystem:nextHop inGalaxy:galaxy_number];
        concealment = [systemInfo oo_intForKey:@"concealment" defaultValue:OO_SYSTEMCONCEALMENT_NONE];
        if (concealment >= OO_SYSTEMCONCEALMENT_NONAME) nextHopSystemName = DESC(@"status-unknown-system");
        targetSystemName = OOExpandKey(@"status-hyperspace-system-multi", targetSystemName, nextHopSystemName);
    }
 
    // GUI stuff
    {
        NSString            *shipName = [self displayName];
        NSString            *legal_desc = nil, *rating_desc = nil,
                            *alert_desc = nil, *fuel_desc = nil,
                            *credits_desc = nil;
        
        OOGUIRow            i;
        OOGUITabSettings    tab_stops;
        tab_stops[0] = 20;
        tab_stops[1] = 160;
        tab_stops[2] = 290;
        [gui overrideTabs:tab_stops from:kGuiStatusTabs length:3];
        [gui setTabStops:tab_stops];
        
        NSString    *lightYearsDesc = DESC(@"status-light-years-desc");
        
        legal_desc = OODisplayStringFromLegalStatus(legalStatus);
        rating_desc = KillCountToRatingAndKillString(ship_kills);
        alert_desc = OODisplayStringFromAlertCondition([self alertCondition]);
        fuel_desc = [NSString stringWithFormat:@"%.1f %@", fuel/10.0, lightYearsDesc];
        credits_desc = OOCredits(credits);
        
        [gui clearAndKeepBackground:!guiChanged];
        text = DESC(@"status-commander-@");
        [gui setTitle:[NSString stringWithFormat:text, [self commanderName]]];
        
        [gui setText:shipName forRow:0 align:GUI_ALIGN_CENTER];
        
        [gui setArray:[NSArray arrayWithObjects:DESC(@"status-present-system"), systemName, nil]    forRow:1];
        if ([self hasHyperspaceMotor]) [gui setArray:[NSArray arrayWithObjects:DESC(@"status-hyperspace-system"), targetSystemName, nil] forRow:2];
        [gui setArray:[NSArray arrayWithObjects:DESC(@"status-condition"), alert_desc, nil]         forRow:3];
        [gui setArray:[NSArray arrayWithObjects:DESC(@"status-fuel"), fuel_desc, nil]               forRow:4];
        [gui setArray:[NSArray arrayWithObjects:DESC(@"status-cash"), credits_desc, nil]            forRow:5];
        [gui setArray:[NSArray arrayWithObjects:DESC(@"status-legal-status"), legal_desc, nil]      forRow:6];
        [gui setArray:[NSArray arrayWithObjects:DESC(@"status-rating"), rating_desc, nil]           forRow:7];
        
 
        [gui setColor:[gui colorFromSetting:kGuiStatusShipnameColor defaultValue:nil] forRow:0];
        for (i = 1 ; i <= 7 ; ++i)
        {
            // nil default = fall back to global default colour
            [gui setColor:[gui colorFromSetting:kGuiStatusDataColor defaultValue:nil] forRow:i];
        }
 
        [gui setText:DESC(@"status-equipment") forRow:9];
 
        [gui setColor:[gui colorFromSetting:kGuiStatusEquipmentHeadingColor defaultValue:nil] forRow:9];
        
        [gui setShowTextCursor:NO];
    }
    /* ends */
 
    if (lastTextKey)
    {
        [lastTextKey release];
        lastTextKey = nil;
    }
    
    [[UNIVERSE gameView] clearMouse];
    
    // Contributed by Pleb - show ship model if the appropriate user default key has been set - Nikos 20140127
    if (EXPECT_NOT([[NSUserDefaults standardUserDefaults] boolForKey:@"show-ship-model-in-status-screen"]))
    {
        [UNIVERSE removeDemoShips];
        [self showShipModelWithKey:[self shipDataKey] shipData:nil personality:[self entityPersonalityInt]
                                    factorX:2.5 factorY:1.7 factorZ:8.0 inContext:@"GUI_SCREEN_STATUS"];
        [self setShowDemoShips:YES];
    }
    else
    {
        [self setShowDemoShips:NO];
    }
    
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO];
    
    if (guiChanged)
    {
        NSDictionary *fgDescriptor = nil, *bgDescriptor = nil;
        if ([self status] == STATUS_DOCKED)
        {
            fgDescriptor = [UNIVERSE screenTextureDescriptorForKey:@"docked_overlay"];
            bgDescriptor = [UNIVERSE screenTextureDescriptorForKey:@"status_docked"];
        }
        else
        {
            fgDescriptor = [UNIVERSE screenTextureDescriptorForKey:@"overlay"];
            if (alertCondition == ALERT_CONDITION_RED) bgDescriptor = [UNIVERSE screenTextureDescriptorForKey:@"status_red_alert"];
            else bgDescriptor = [UNIVERSE screenTextureDescriptorForKey:@"status_in_flight"];
        }
        
        [gui setForegroundTextureDescriptor:fgDescriptor];
        
        if (bgDescriptor == nil)  bgDescriptor = [UNIVERSE screenTextureDescriptorForKey:@"status"];
        [gui setBackgroundTextureDescriptor:bgDescriptor];
        
        [gui setStatusPage:0];
        [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
    }
}

setGuiToStickMapperScreen:

- (void) setGuiToStickMapperScreen:

(unsigned)

skip

Provided by category PlayerEntity(StickMapper).

Definition at line 1 of file PlayerEntityStickMapper.m.

                                  :(unsigned)skip
{
    [self setGuiToStickMapperScreen: skip resetCurrentRow: NO];
}

setGuiToStickMapperScreen:resetCurrentRow:

- (void) setGuiToStickMapperScreen:		(unsigned)	skip
resetCurrentRow:		(BOOL)	resetCurrentRow

Provided by category PlayerEntity(StickMapper).

Definition at line 1 of file PlayerEntityStickMapper.m.

                                  :(unsigned)skip resetCurrentRow: (BOOL) resetCurrentRow
{
    GuiDisplayGen   *gui = [UNIVERSE gui];
    OOJoystickManager   *stickHandler = [OOJoystickManager sharedStickHandler];
    NSArray     *stickList = [stickHandler listSticks];
    unsigned        stickCount = [stickList count];
    unsigned        i;
    
    OOGUITabStop    tabStop[GUI_MAX_COLUMNS];
    tabStop[0] = 10;
    tabStop[1] = 290;
    tabStop[2] = 400;
    [gui setTabStops:tabStop];
    
    gui_screen = GUI_SCREEN_STICKMAPPER;
    [gui clear];
    [gui setTitle:[NSString stringWithFormat:@"Configure Joysticks"]];
    
    for(i=0; i < stickCount; i++)
    {
        NSString *stickNameForThisRow = [NSString stringWithFormat: @"Stick %d %@", i+1, [stickList objectAtIndex: i]];
        // for more than 2 sticks, the stick name rows are populated by more than one name if needed
        NSString *stickNameAdditional = nil;
        if (stickCount > 2 && OOStringWidthInEm(stickNameForThisRow) > 18.0)
        {
            // string is too long, truncate it until its length gets below threshold
            do {
                stickNameForThisRow = [[stickNameForThisRow substringToIndex:[stickNameForThisRow length] - 5] 
                                        stringByAppendingString:@"..."];
            } while (OOStringWidthInEm(stickNameForThisRow) > 18.0);
        }
        unsigned j = i + 2;
        if (j < stickCount)
        {
            stickNameAdditional = [NSString stringWithFormat: @"Stick %d %@", j+1, [stickList objectAtIndex: j]];
            if (OOStringWidthInEm(stickNameAdditional) > 11.0)
            {
                // string is too long, truncate it until its length gets below threshold
                do {
                stickNameAdditional = [[stickNameAdditional substringToIndex:[stickNameAdditional length] - 5] 
                                        stringByAppendingString:@"..."];
                } while (OOStringWidthInEm(stickNameAdditional) > 11.0);
            }
        }
        [gui setArray:[NSArray arrayWithObjects:
                       stickNameForThisRow,
                       @"", // skip one column
                       stickNameAdditional,
                       nil]
               forRow:i + GUI_ROW_STICKNAME];
    }
 
    [gui setArray: [NSArray arrayWithObjects: DESC(@"stickmapper-profile"), nil] forRow: GUI_ROW_STICKPROFILE];
    [gui setKey: GUI_KEY_OK forRow: GUI_ROW_STICKPROFILE];
    [self displayFunctionList:gui skip:skip];
    
    [gui setArray:[NSArray arrayWithObject:@"Select a function and press Enter to modify or 'u' to unset."]
           forRow:GUI_ROW_INSTRUCT];
           
    [gui setText:@"Space to return to previous screen." forRow:GUI_ROW_INSTRUCT+1 align:GUI_ALIGN_CENTER];
    
    if (resetCurrentRow)
    {
        [gui setSelectedRow: GUI_ROW_STICKPROFILE];
    }
    [[UNIVERSE gameView] suppressKeysUntilKeyUp];
    [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"paused_overlay"];
    [gui setBackgroundTextureKey:@"settings"];
}

setGuiToStickProfileScreen:

- (void) setGuiToStickProfileScreen:

(GuiDisplayGen *)

gui

Provided by category PlayerEntity(StickProfile).

Definition at line 43 of file PlayerEntityStickProfile.m.

                                   : (GuiDisplayGen *) gui
{
    gui_screen = GUI_SCREEN_STICKPROFILE;
    [stickProfileScreen startGui: gui];
    return;
}

setGuiToSystemDataScreen

- (void) setGuiToSystemDataScreen

Definition at line 13727 of file PlayerEntity.m.

{
    [self setGuiToSystemDataScreenRefreshBackground: NO];
}

setGuiToSystemDataScreenRefreshBackground:

- (void) setGuiToSystemDataScreenRefreshBackground:

(BOOL)

refreshBackground

Definition at line 13727 of file PlayerEntity.m.

                                                  : (BOOL) refreshBackground
{
    NSDictionary    *infoSystemData;
    NSString        *infoSystemName;
    
    infoSystemData = [[UNIVERSE generateSystemData:info_system_id] retain];  // retained
    NSInteger concealment = [infoSystemData oo_intForKey:@"concealment" defaultValue:OO_SYSTEMCONCEALMENT_NONE];
    infoSystemName = [infoSystemData oo_stringForKey:KEY_NAME];
    
    BOOL            sunGoneNova = ([infoSystemData oo_boolForKey:@"sun_gone_nova"]);
    OOGUIScreenID   oldScreen = gui_screen;
    
    GuiDisplayGen   *gui = [UNIVERSE gui];
    gui_screen = GUI_SCREEN_SYSTEM_DATA;
    BOOL            guiChanged = (oldScreen != gui_screen);
 
    Random_Seed     infoSystemRandomSeed = [[UNIVERSE systemManager] getRandomSeedForSystem:info_system_id
                                                                                  inGalaxy:[self galaxyNumber]];
    
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:NO];
    
    // GUI stuff
    {
        OOGUITabSettings tab_stops;
        tab_stops[0] = 0;
        tab_stops[1] = 96;
        tab_stops[2] = 144;
        [gui overrideTabs:tab_stops from:kGuiSystemdataTabs length:3];
        [gui setTabStops:tab_stops];
        
        NSUInteger techLevel = [infoSystemData oo_intForKey:KEY_TECHLEVEL] + 1;
        int population = [infoSystemData oo_intForKey:KEY_POPULATION];
        int productivity = [infoSystemData oo_intForKey:KEY_PRODUCTIVITY];
        int radius = [infoSystemData oo_intForKey:KEY_RADIUS];
        
        NSString    *government_desc =  [infoSystemData oo_stringForKey:KEY_GOVERNMENT_DESC 
                                                             defaultValue:OODisplayStringFromGovernmentID([infoSystemData oo_intForKey:KEY_GOVERNMENT])];
        NSString    *economy_desc =     [infoSystemData oo_stringForKey:KEY_ECONOMY_DESC 
                                                             defaultValue:OODisplayStringFromEconomyID([infoSystemData oo_intForKey:KEY_ECONOMY])];
        NSString    *inhabitants =      [infoSystemData oo_stringForKey:KEY_INHABITANTS];
        NSString    *system_desc =      [infoSystemData oo_stringForKey:KEY_DESCRIPTION];
 
        NSString    *populationDesc =   [infoSystemData oo_stringForKey:KEY_POPULATION_DESC
                                                             defaultValue:OOExpandKeyWithSeed(kNilRandomSeed, @"sysdata-pop-value", population)];
 
        if (sunGoneNova)
        {
            population = 0;
            productivity = 0;
            radius = 0;
            techLevel = 0;
 
            government_desc = OOExpandKeyWithSeed(infoSystemRandomSeed, @"nova-system-government");
            economy_desc = OOExpandKeyWithSeed(infoSystemRandomSeed, @"nova-system-economy");
            inhabitants = OOExpandKeyWithSeed(infoSystemRandomSeed, @"nova-system-inhabitants");
            {
                NSString *system = infoSystemName;
                system_desc = OOExpandKeyWithSeed(infoSystemRandomSeed, @"nova-system-description", system);
            }
            populationDesc = OOExpandKeyWithSeed(infoSystemRandomSeed, @"sysdata-pop-value", population);
        }
 
        
        [gui clearAndKeepBackground:!refreshBackground && !guiChanged];
        [UNIVERSE removeDemoShips];
 
        if (concealment < OO_SYSTEMCONCEALMENT_NONAME)
        {
            NSString *system = infoSystemName;
            [gui setTitle:OOExpandKeyWithSeed(infoSystemRandomSeed, @"sysdata-data-on-system", system)];
        }
        else
        {
            [gui setTitle:OOExpandKey(@"sysdata-data-on-system-no-name")];
        }
 
        if (concealment >= OO_SYSTEMCONCEALMENT_NODATA)
        {
            OOGUIRow i = [gui addLongText:OOExpandKey(@"sysdata-data-on-system-no-data") startingAtRow:15 align:GUI_ALIGN_LEFT];
            missionTextRow = i;
            for (i-- ; i > 14 ; --i)
            {
                [gui setColor:[gui colorFromSetting:kGuiSystemdataDescriptionColor defaultValue:[OOColor greenColor]] forRow:i];
            }
        }
        else
        {
            NSPoint infoSystemCoordinates = [[UNIVERSE systemManager] getCoordinatesForSystem: info_system_id inGalaxy: galaxy_number];
            double distance = distanceBetweenPlanetPositions(infoSystemCoordinates.x, infoSystemCoordinates.y, galaxy_coordinates.x, galaxy_coordinates.y);
            if(distance == 0.0 && info_system_id != system_id)
            {
                distance = 0.1;
            }
            NSString *distanceInfo = [NSString stringWithFormat: @"%.1f ly", distance];
            if (ANA_mode != OPTIMIZED_BY_NONE)
            {
                NSDictionary *routeInfo = nil;
                routeInfo = [UNIVERSE routeFromSystem: system_id toSystem: info_system_id optimizedBy: ANA_mode];
                if (routeInfo != nil)
                {
                    double routeDistance = [[routeInfo objectForKey: @"distance"] doubleValue];
                    double routeTime = [[routeInfo objectForKey: @"time"] doubleValue];
                    int routeJumps = [[routeInfo objectForKey: @"jumps"] intValue];
                    if(routeDistance == 0.0 && info_system_id != system_id) {
                        routeDistance = 0.1;
                        routeTime = 0.01;
                        routeJumps = 0;
                    }
                    distanceInfo = [NSString stringWithFormat: @"%.1f ly / %.1f %@ / %d %@",
                            routeDistance,
                            routeTime,
                            // don't rely on DESC_PLURAL for routeTime since it is of type double
                            routeTime > 1.05 || routeTime < 0.95 ? DESC(@"sysdata-route-hours%1") : DESC(@"sysdata-route-hours%0"),
                            routeJumps,
                            DESC_PLURAL(@"sysdata-route-jumps", routeJumps)];
                }
            }
 
            OOGUIRow i;
 
            for (i = 1; i <= 16; i++) {
                NSString *ln = [NSString stringWithFormat:@"sysdata-line-%ld", (long)i];
                NSString *line = OOExpandKeyWithSeed(infoSystemRandomSeed, ln, economy_desc, government_desc, techLevel, populationDesc, inhabitants, productivity, radius, distanceInfo);
                if (![line isEqualToString:@""])
                {
                    NSArray *lines = [line componentsSeparatedByString:@"\t"];
                    if ([lines count] == 1) 
                    {
                        [gui setArray:[NSArray arrayWithObjects:[lines objectAtIndex:0],
                                    nil]
                            forRow:i];
                    } 
                    if ([lines count] == 2) 
                    {
                        [gui setArray:[NSArray arrayWithObjects:[lines objectAtIndex:0],
                                        [lines objectAtIndex:1],
                                    nil]
                            forRow:i];
                    }
                    if ([lines count] == 3) 
                    {
                        if ([[lines objectAtIndex:2] isEqualToString:@""]) 
                        {
                            [gui setArray:[NSArray arrayWithObjects:[lines objectAtIndex:0],
                                            [lines objectAtIndex:1],
                                        nil]
                                forRow:i];
                        } 
                        else
                        {
                            [gui setArray:[NSArray arrayWithObjects:[lines objectAtIndex:0],
                                            [lines objectAtIndex:1],
                                            [lines objectAtIndex:2],
                                        nil]
                                forRow:i];
                        }
                    }
                }
                else 
                {
                    [gui setArray:[NSArray arrayWithObjects:@"",
                                nil]
                        forRow:i];
                }
            }
 
 
            i = [gui addLongText:system_desc startingAtRow:17 align:GUI_ALIGN_LEFT];
            missionTextRow = i;
            for (i-- ; i > 16 ; --i)
            {
                [gui setColor:[gui colorFromSetting:kGuiSystemdataDescriptionColor defaultValue:[OOColor greenColor]] forRow:i];
            }
            for (i = 1 ; i <= 14 ; ++i)
            {
                // nil default = fall back to global default colour
                [gui setColor:[gui colorFromSetting:kGuiSystemdataFactsColor defaultValue:nil] forRow:i];
            }
        }
 
        [gui setShowTextCursor:NO];
    }
    /* ends */
    
    [lastTextKey release];
    lastTextKey = nil;
    
    [[UNIVERSE gameView] clearMouse];
    
    [infoSystemData release];
    
    [self setShowDemoShips:NO];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO];
    
    // if the system has gone nova, there's no planet to display
    if (!sunGoneNova && concealment < OO_SYSTEMCONCEALMENT_NODATA)
    {
        // The next code is generating the miniature planets.
        // When normal planets are displayed, the PRNG is reset. This happens not with procedural planet display.
        RANROTSeed ranrotSavedSeed = RANROTGetFullSeed();
        RNG_Seed saved_seed = currentRandomSeed();
        
        if (info_system_id == system_id)
        {
            [self setBackgroundFromDescriptionsKey:@"gui-scene-show-local-planet"];
        }
        else
        {
            [self setBackgroundFromDescriptionsKey:@"gui-scene-show-planet"];
        }
        
        setRandomSeed(saved_seed);
        RANROTSetFullSeed(ranrotSavedSeed);
    }
    
    if (refreshBackground || guiChanged)
    {
        [gui setForegroundTextureKey:[self status] == STATUS_DOCKED ? @"docked_overlay" : @"overlay"];
        [gui setBackgroundTextureKey:sunGoneNova ? @"system_data_nova" : @"system_data"];
        
        [self noteGUIDidChangeFrom:oldScreen to:gui_screen refresh: refreshBackground];
        [self checkScript]; // Still needed by some OXPs?
    }
}

setInfoSystemID:moveChart:

- (void) setInfoSystemID:		(OOSystemID)	sid
moveChart:		(BOOL)	moveChart

Definition at line 13727 of file PlayerEntity.m.

                        : (OOSystemID) sid moveChart: (BOOL) moveChart
{
    if (sid != info_system_id)
    {
        OOSystemID old = info_system_id;
        info_system_id = sid;
        JSContext *context = OOJSAcquireContext();
        ShipScriptEvent(context, self, "infoSystemWillChange", INT_TO_JSVAL(info_system_id), INT_TO_JSVAL(old));
        if (gui_screen == GUI_SCREEN_LONG_RANGE_CHART || gui_screen == GUI_SCREEN_SHORT_RANGE_CHART)
        {
            if(moveChart)
            {
                target_chart_focus = [[UNIVERSE systemManager] getCoordinatesForSystem:info_system_id inGalaxy:galaxy_number];
            }
        }
        else
        {
            if(gui_screen == GUI_SCREEN_SYSTEM_DATA)
            {
                [self setGuiToSystemDataScreenRefreshBackground: YES];
            }
            if(moveChart)
            {
                chart_centre_coordinates = [[UNIVERSE systemManager] getCoordinatesForSystem:info_system_id inGalaxy:galaxy_number];
                target_chart_centre = chart_centre_coordinates;
                chart_focus_coordinates = chart_centre_coordinates;
                target_chart_focus = chart_focus_coordinates;
            }
        }
        ShipScriptEvent(context, self, "infoSystemChanged", INT_TO_JSVAL(info_system_id), INT_TO_JSVAL(old));
        OOJSRelinquishContext(context);
    }
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setJSSelf:context:

- (void) setJSSelf:		(JSObject *)	val
context:		(JSContext *)	context

Provided by category PlayerEntity(OOJavaScriptExtensions).

Definition at line 1860 of file OOJSPlayerShip.m.

                  :(JSObject *)val context:(JSContext *)context
{
    _jsSelf = val;
    OOJSAddGCObjectRoot(context, &_jsSelf, "Player jsSelf");
    
    [[NSNotificationCenter defaultCenter] addObserver:self
                                             selector:@selector(javaScriptEngineWillReset:)
                                                 name:kOOJavaScriptEngineWillResetNotification
                                               object:[OOJavaScriptEngine sharedEngine]];
}

Referenced by InitOOJSPlayerShip().

Here is the caller graph for this function:

setJumpCause:

- (void) setJumpCause:

(NSString *)

value

Definition at line 9242 of file PlayerEntity.m.

                     :(NSString *)value
{
    NSParameterAssert(value != nil);
    [_jumpCause autorelease];
    _jumpCause = [value copy];
}

setJumpType:

- (void) setJumpType:

(BOOL)

isGalacticJump

Definition at line 13727 of file PlayerEntity.m.

                    :(BOOL)isGalacticJump
{
    if (isGalacticJump)
    {
        galactic_witchjump = YES;
    }
    else
    {
        galactic_witchjump = NO;
    }
}

Referenced by PlayerShipBeginGalacticHyperspaceCountdown(), and PlayerShipCancelHyperspaceCountdown().

Here is the caller graph for this function:

setLastsaveName:

- (void) setLastsaveName:

(NSString *)

value

Definition at line 9242 of file PlayerEntity.m.

                        :(NSString *)value
{
    NSParameterAssert(value != nil);
    [_lastsaveName autorelease];
    _lastsaveName = [value copy];
}

setLastShot:

- (void) setLastShot:

(NSArray *)

shot

Definition at line 9242 of file PlayerEntity.m.

                    :(NSArray *)shot
{
    lastShot = [shot retain]; 
}

setLegalStatus:

- (void) setLegalStatus:

(NSString *)

valueString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                       :(NSString *)valueString
{
    legalStatus = [valueString intValue];
}

setLocalVariable:forKey:andMission:

- (void) setLocalVariable:		(NSString *)	value
forKey:		(NSString *)	variableName
andMission:		(NSString *)	missionKey

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)value forKey:(NSString *)variableName andMission:(NSString *)missionKey
{
    NSMutableDictionary     *locals = nil;
    
    if (variableName != nil && missionKey != nil)
    {
        locals = [self localVariablesForMission:missionKey];
        if (value != nil)
        {
            [locals setObject:value forKey:variableName];
        }
        else
        {
            [locals removeObjectForKey:variableName];
        }
    }
}

setLongRangeChartMode:

- (void) setLongRangeChartMode:

(OOLongRangeChartMode)

mode

Definition at line 9242 of file PlayerEntity.m.

                              :(OOLongRangeChartMode) mode
{
    longRangeChartMode = mode;
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setManifestScreenRow:inColor:forRow:ofRows:andOffset:inMultipage:

- (void) setManifestScreenRow:		(id)	object
inColor:		(OOColor*)	color
forRow:		(OOGUIRow)	row
ofRows:		(OOGUIRow)	max_rows
andOffset:		(OOGUIRow)	offset
inMultipage:		(BOOL)	multi

Provided by category PlayerEntity(Contracts).

Definition at line 1998 of file PlayerEntityContracts.m.

                             :(id)object inColor:(OOColor*)color forRow:(OOGUIRow)row ofRows:(OOGUIRow)max_rows andOffset:(OOGUIRow)offset inMultipage:(BOOL)multi
{
    OOGUIRow disp_row = row - offset;
    if (disp_row < 1 || disp_row > max_rows) return;
    if (multi) disp_row++;
    GuiDisplayGen   *gui = [UNIVERSE gui];
    if ([object isKindOfClass:[NSString class]])
    {
        [gui setText:(NSString*)object forRow:disp_row];
    }
    else if ([object isKindOfClass:[NSArray class]])
    {
        [gui setArray:(NSArray*)object forRow:disp_row];
    }
    [gui setColor:color forRow:disp_row];
}

setMassLockable:

- (void) setMassLockable:

(BOOL)

newValue

Definition at line 13727 of file PlayerEntity.m.

                        :(BOOL)newValue
{
    massLockable = !!newValue;
    [self updateAlertCondition];
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setMaxAftShieldLevel:

- (void) setMaxAftShieldLevel:

(float)

new

Definition at line 13727 of file PlayerEntity.m.

                             :(float)new
{
    max_aft_shield = new;
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setMaxFlightPitch:

- (void) setMaxFlightPitch: (GLfloat)  new

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                          :(GLfloat)new
{
    max_flight_pitch = new;
    pitch_delta = 2.0 * new;
}

setMaxFlightRoll:

- (void) setMaxFlightRoll: (GLfloat)  new

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                         :(GLfloat)new
{
    max_flight_roll = new;
    roll_delta = 2.0 * new;
}

setMaxFlightYaw:

- (void) setMaxFlightYaw: (GLfloat)  new

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                        :(GLfloat)new
{
    max_flight_yaw = new;
    yaw_delta = 2.0 * new;
}

setMaxForwardShieldLevel:

- (void) setMaxForwardShieldLevel:

(float)

new

Definition at line 13727 of file PlayerEntity.m.

                                 :(float)new
{
    max_forward_shield = new;
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setMissionBackground:

- (void) setMissionBackground: (NSString *)  value

implementation

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                             :(NSString *)value
{
    if ([value length] != 0 && ![[value lowercaseString] isEqualToString:@"none"])
    {
        [self setMissionBackgroundDescriptor:[NSDictionary dictionaryWithObject:value forKey:@"name"]];
    }
    else
    {
        [self setMissionBackgroundDescriptor:nil];
    }
}

setMissionBackgroundDescriptor:

- (void) setMissionBackgroundDescriptor:

(NSDictionary *)

descriptor

Definition at line 9242 of file PlayerEntity.m.

                                       :(NSDictionary *)descriptor
{
    if (descriptor != _missionBackgroundDescriptor)
    {
        [_missionBackgroundDescriptor autorelease];
        _missionBackgroundDescriptor = [descriptor copy];
    }
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setMissionBackgroundSpecial:

- (void) setMissionBackgroundSpecial:

(NSString *)

special

Definition at line 9242 of file PlayerEntity.m.

                                    :(NSString *)special
{
    if (special == nil) {
        _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_NONE;
    }
    else if ([special isEqualToString:@"SHORT_RANGE_CHART"])
    {
        _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_SHORT;
    }
    else if ([special isEqualToString:@"SHORT_RANGE_CHART_SHORTEST"])
    {
        if ([self hasEquipmentItemProviding:@"EQ_ADVANCED_NAVIGATIONAL_ARRAY"])
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_SHORT_ANA_SHORTEST;
        }
        else
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_SHORT;
        }
    }
    else if ([special isEqualToString:@"SHORT_RANGE_CHART_QUICKEST"])
    {
        if ([self hasEquipmentItemProviding:@"EQ_ADVANCED_NAVIGATIONAL_ARRAY"])
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_SHORT_ANA_QUICKEST;
        }
        else
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_SHORT;
        }
    } 
    else if ([special isEqualToString:@"CUSTOM_CHART"])
    {
        _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_CUSTOM;
    }
    else if ([special isEqualToString:@"CUSTOM_CHART_SHORTEST"])
    {
        if ([self hasEquipmentItemProviding:@"EQ_ADVANCED_NAVIGATIONAL_ARRAY"])
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_CUSTOM_ANA_SHORTEST;
        }
        else
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_CUSTOM;
        }
    }
    else if ([special isEqualToString:@"CUSTOM_CHART_QUICKEST"])
    {
        if ([self hasEquipmentItemProviding:@"EQ_ADVANCED_NAVIGATIONAL_ARRAY"])
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_CUSTOM_ANA_QUICKEST;
        }
        else
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_CUSTOM;
        }
    } 
    else if ([special isEqualToString:@"LONG_RANGE_CHART"])
    {
        _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_LONG;
    }
    else if ([special isEqualToString:@"LONG_RANGE_CHART_SHORTEST"])
    {
        if ([self hasEquipmentItemProviding:@"EQ_ADVANCED_NAVIGATIONAL_ARRAY"])
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_LONG_ANA_SHORTEST;
        }
        else
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_LONG;
        }
    }
    else if ([special isEqualToString:@"LONG_RANGE_CHART_QUICKEST"])
    {
        if ([self hasEquipmentItemProviding:@"EQ_ADVANCED_NAVIGATIONAL_ARRAY"])
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_LONG_ANA_QUICKEST;
        }
        else
        {
            _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_LONG;
        }
    } 
    else 
    {
        _missionBackgroundSpecial = GUI_BACKGROUND_SPECIAL_NONE;
    }
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setMissionChoice:

- (void) setMissionChoice:

(NSString *)

newChoice

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                         :(NSString *)newChoice
{
    [self setMissionChoice:newChoice keyPress:@"" withEvent:YES];
}

setMissionChoice:keyPress:

- (void) setMissionChoice:		(NSString *)	newChoice
keyPress:		(NSString *)	keyPress

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                         :(NSString *)newChoice keyPress:(NSString *)keyPress
{
    [self setMissionChoice:newChoice keyPress:keyPress withEvent:YES];
}

setMissionChoice:keyPress:withEvent:

- (void) setMissionChoice:		(NSString *)	newChoice
keyPress:		(NSString *)	keyPress
withEvent:		(BOOL)	withEvent

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                         :(NSString *)newChoice keyPress:(NSString *)keyPress withEvent:(BOOL)withEvent
{
    BOOL equal = [newChoice isEqualToString:missionChoice] || (newChoice == missionChoice); // Catch both being nil as well
    if (!equal)
    {
        if (newChoice == nil)
        {
            NSString *oldChoice = missionChoice;
            [missionChoice autorelease];
            missionChoice = nil;
            if (withEvent) [self doScriptEvent:OOJSID("missionChoiceWasReset") withArgument:oldChoice];
        }
        else
        {
            [missionChoice autorelease];
            missionChoice = [newChoice copy];
        }
    }
    equal = [keyPress isEqualToString:missionKeyPress] || (keyPress == missionKeyPress);
    if (!equal) 
    {
        [missionKeyPress autorelease];
        missionKeyPress = [keyPress copy];
    }
}

Referenced by MissionRunCallback().

Here is the caller graph for this function:

setMissionChoice:withEvent:

- (void) setMissionChoice:		(NSString *)	newChoice
withEvent:		(BOOL)	withEvent

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                         :(NSString *)newChoice withEvent:(BOOL)withEvent
{
    [self setMissionChoice:newChoice keyPress:@"" withEvent:withEvent];
}

setMissionChoiceByTextEntry:

- (void) setMissionChoiceByTextEntry:

(BOOL)

enable

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                                    :(BOOL)enable
{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    _missionTextEntry = enable;
    [gameView resetTypedString];
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setMissionChoices:

- (void) setMissionChoices:

(NSString *)

choicesKey

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                          :(NSString *)choicesKey   // choicesKey is a key for a dictionary of
{                                                   // choices/choice phrases in missiontext.plist and also..
    NSDictionary *choicesDict = [[UNIVERSE missiontext] oo_dictionaryForKey:choicesKey];
    if ([choicesDict count] == 0)
    {
        return;
    }
    [self setMissionChoicesDictionary:choicesDict];
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setMissionChoicesDictionary:

- (void) setMissionChoicesDictionary:

(NSDictionary *)

choicesDict

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                                    :(NSDictionary *)choicesDict
{
    unsigned i;
    bool keysOK = true;
    GuiDisplayGen* gui = [UNIVERSE gui];
    // TODO: MORE STUFF HERE
    //
    // What it does now:
    // find list of choices in missiontext.plist
    // add them to gui setting the key for each line to the key in the dict of choices
    // and the text of the line to the value in the dict of choices
    // and also set the selectable range
    // ++ change the mission screen's response to wait for a choice
    // and only if the selectable range is not present ask:
    // Press Space Commander...
    //
    
    NSUInteger end_row = 21;
    if ([[self hud] allowBigGui]) 
    {
        end_row = 27;
    }
 
    NSArray *choiceKeys = [choicesDict allKeys];
    /* Guard against potential for numeric keys in dictionary, which
     * would cause an unhandled exception in the sorter. See
     * OOJavaScriptEngine::OOJSDictionaryFromJSObject for further
     * thoughts. - CIM 15/2/13 */
    for (i=0; i < [choiceKeys count]; i++)
    {
        if (![[choiceKeys objectAtIndex:i] isKindOfClass:[NSString class]])
        {
            OOLog(@"test.script.error",@"Choices list in mission screen has non-string value %@",[choiceKeys objectAtIndex:i]);
            keysOK = false;
        }
    }   
    if (keysOK)
    {
        // only try this if they're all strings
        choiceKeys = [choiceKeys sortedArrayUsingSelector:@selector(caseInsensitiveCompare:)];
    }
 
    NSInteger keysCount = [choiceKeys count];
    if ((end_row + 1) < [choiceKeys count]) {
        OOLogERR(kOOLogException, @"in mission.runScreen choices: number of choices defined (%llu) is greater than available lines (%llu). Check HUD settings for allowBigGui.",  [choiceKeys count], (end_row + 1));
        keysCount = end_row + 1;
    }
 
    [gui setText:@"" forRow:end_row];               // clears out the 'Press spacebar' message
    [gui setKey:@"" forRow:end_row];                    // clears the key to enable pollDemoControls to check for a selection
    [gui setSelectableRange:NSMakeRange(0,0)];  // clears the selectable range
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES]; // enables mouse selection of the choices list items
    
    OOGUIRow            choicesRow = (end_row+1) - keysCount;
    NSString            *choiceKey = nil;
    id                  choiceValue = nil;
    NSString            *choiceText = nil;
    
    BOOL selectableRowExists = NO;
    NSUInteger firstSelectableRow = end_row;
 
    foreach (choiceKey, choiceKeys)
    {
        choiceValue = [choicesDict objectForKey:choiceKey];
        OOGUIAlignment alignment = GUI_ALIGN_CENTER;
        OOColor *rowColor = [OOColor yellowColor];
        BOOL selectable = YES;
        if ([choiceValue isKindOfClass:[NSString class]])
        {
            choiceText = [NSString stringWithFormat:@" %@ ",(NSString*)choiceValue];
        } 
        else if ([choiceValue isKindOfClass:[NSDictionary class]])
        {
            NSDictionary *choiceOpts = (NSDictionary*)choiceValue;
            choiceText = [NSString stringWithFormat:@" %@ ",[choiceOpts oo_stringForKey:@"text"]];
            NSString *alignmentChoice = [choiceOpts oo_stringForKey:@"alignment" defaultValue:@"CENTER"];
            if ([alignmentChoice isEqualToString:@"LEFT"])
            {
                alignment = GUI_ALIGN_LEFT;
            }
            else if ([alignmentChoice isEqualToString:@"RIGHT"])
            {
                alignment = GUI_ALIGN_RIGHT;
            }
            id colorDesc = [choiceOpts objectForKey:@"color"];
            if ([choiceOpts oo_boolForKey:@"unselectable"])
            {
                selectable = NO;
            }
            if (colorDesc != nil)
            {
                rowColor = [OOColor colorWithDescription:colorDesc];
            }
            else if (!selectable) // different default
            {
                rowColor = [OOColor darkGrayColor];
            }
        }
        else
        {
            continue; // invalid type
        }
        choiceText = OOExpand(choiceText);
        choiceText = [self replaceVariablesInString:choiceText];
        // allow blank rows
        if (![choiceText isEqualToString:@"  "])
        {
            [gui setText:choiceText forRow:choicesRow align: alignment];
            if (selectable)
            {
                [gui setKey:choiceKey forRow:choicesRow];
            }
            else
            {
                [gui setKey:GUI_KEY_SKIP forRow:choicesRow];
            }
            [gui setColor:rowColor forRow:choicesRow];
            if (selectable && !selectableRowExists)
            {
                selectableRowExists = YES;
                firstSelectableRow = choicesRow;
            }
        }
        else 
        {
            [gui setKey:GUI_KEY_SKIP forRow:choicesRow];
        }
        choicesRow++;
        if (choicesRow > (end_row + 1)) break;
    }
    
    if (!selectableRowExists)
    {
        // just in case choices are set but they're all blank.
        [gui setText:@"  " forRow:end_row align: GUI_ALIGN_CENTER];
        [gui setKey:@"" forRow:end_row];
        [gui setColor:[OOColor yellowColor] forRow:end_row];
    }
 
    [gui setSelectableRange:NSMakeRange((end_row+1) - keysCount, keysCount)];
    [gui setSelectedRow: firstSelectableRow];
    
    [self resetMissionChoice];
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setMissionDescription:

- (void) setMissionDescription:

(NSString *)

textKey

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                              :(NSString *)textKey
{
    [self setMissionDescription:textKey forMission:sCurrentMissionKey];
}

setMissionDescription:forMission:

- (void) setMissionDescription:		(NSString *)	textKey
forMission:		(NSString *)	key

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                              :(NSString *)textKey forMission:(NSString *)key
{
    NSString        *text = [[UNIVERSE missiontext] oo_stringForKey:textKey];
    
    if (!text)
    {
        OOLogERR(kOOLogScriptMissionDescNoText, @"in %@, no mission text set for key '%@' [UNIVERSE missiontext] is:\n%@ ", CurrentScriptDesc(), textKey, [UNIVERSE missiontext]);
        return;
    }
    
    [self setMissionInstructions:text forMission:key];
}

Referenced by MissionSetInstructionsInternal().

Here is the caller graph for this function:

setMissionExitScreen:

- (void) setMissionExitScreen:

(OOGUIScreenID)

screen

Definition at line 9242 of file PlayerEntity.m.

                             :(OOGUIScreenID)screen
{
    _missionExitScreen = screen;
}

Referenced by MissionRunScreen(), and MissionSetProperty().

Here is the caller graph for this function:

setMissionImage:

- (void) setMissionImage: (NSString *)  value

implementation

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)value
{
    if ([value length] != 0 && ![[value lowercaseString] isEqualToString:@"none"])
    {
        [self setMissionOverlayDescriptor:[NSDictionary dictionaryWithObject:value forKey:@"name"]];
    }
    else
    {
        [self setMissionOverlayDescriptor:nil];
    }
 
}

setMissionInstructions:forMission:

- (void) setMissionInstructions:		(NSString *)	text
forMission:		(NSString *)	key

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                               :(NSString *)text forMission:(NSString *)key
{
    if (!key)
    {
        OOLogERR(kOOLogScriptMissionDescNoKey, @"in %@, mission key not set", CurrentScriptDesc());
        return;
    }
 
    text = OOExpand(text);
    text = [self replaceVariablesInString: text];
 
    [mission_variables setObject:text forKey:key];
}

Referenced by MissionSetInstructionsInternal().

Here is the caller graph for this function:

setMissionInstructionsList:forMission:

- (void) setMissionInstructionsList:		(NSArray *)	list
forMission:		(NSString *)	key

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                                   :(NSArray *)list forMission:(NSString *)key
{
    if (!key)
    {
        OOLogERR(kOOLogScriptMissionDescNoKey, @"in %@, mission key not set", CurrentScriptDesc());
        return;
    }
 
    NSString *text = nil;
    NSUInteger i,ct = [list count];
    NSMutableArray *expandedList = [NSMutableArray arrayWithCapacity:ct];
    for (i=0 ; i<ct ; i++)
    {
        text = [list oo_stringAtIndex:i defaultValue:nil];
        if (text != nil)
        {
            text = OOExpand(text);
            text = [self replaceVariablesInString: text];
            [expandedList addObject:text];
        }
    }
 
    [mission_variables setObject:expandedList forKey:key];
}

Referenced by MissionSetInstructionsInternal().

Here is the caller graph for this function:

setMissionMusic:

- (void) setMissionMusic:

(NSString *)

value

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)value
{
    if ([value length] == 0 || [[value lowercaseString] isEqualToString:@"none"])
    {
        value = nil;
    }
    [[OOMusicController sharedController] setMissionMusic:value];
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setMissionOverlayDescriptor:

- (void) setMissionOverlayDescriptor:

(NSDictionary *)

descriptor

Definition at line 9242 of file PlayerEntity.m.

                                    :(NSDictionary *)descriptor
{
    if (descriptor != _missionOverlayDescriptor)
    {
        [_missionOverlayDescriptor autorelease];
        _missionOverlayDescriptor = [descriptor copy];
    }
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setMissionScreenID:

- (void) setMissionScreenID:

(NSString *)

msid

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                           :(NSString *)msid
{
    _missionScreenID = [msid retain];
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setMissionTitle:

- (void) setMissionTitle:

(NSString *)

value

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)value
{
    if (_missionTitle != value)
    {
        [_missionTitle release];
        _missionTitle = [value copy];
    }
}

Referenced by MissionRunScreen().

Here is the caller graph for this function:

setMissionVariable:forKey:

- (void) setMissionVariable:		(NSString *)	value
forKey:		(NSString *)	key

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                          :(NSString *)value forKey:(NSString *)key
{
    if (key != nil)
    {
        if (value != nil)  [mission_variables setObject:value forKey:key];
        else [mission_variables removeObjectForKey:key];
    }
}

Referenced by MissionVariablesDeleteProperty(), and MissionVariablesSetProperty().

Here is the caller graph for this function:

setMultiFunctionDisplay:toKey:

- (BOOL) setMultiFunctionDisplay:		(NSUInteger)	index
toKey:		(NSString *)	key

Definition at line 13727 of file PlayerEntity.m.

                                :(NSUInteger)index toKey:(NSString *)key
{
    if (index >= [hud mfdCount])
    {
        // is first inactive display
        index = [multiFunctionDisplaySettings indexOfObject:[NSNull null]];
        if (index == NSNotFound)
        {
            return NO;
        }
    }
 
    if (index < [hud mfdCount])
    {
        if (key == nil)
        {
            [multiFunctionDisplaySettings replaceObjectAtIndex:index withObject:[NSNull null]];
        }
        else
        {
            [multiFunctionDisplaySettings replaceObjectAtIndex:index withObject:key];
        }
        return YES;
    }
    else
    {
        return NO;
    }
}

Referenced by PlayerShipSetMultiFunctionDisplay().

Here is the caller graph for this function:

setMultiFunctionText:forKey:

- (void) setMultiFunctionText:		(NSString *)	text
forKey:		(NSString *)	key

Definition at line 13727 of file PlayerEntity.m.

                             :(NSString *)text forKey:(NSString *)key
{
    if (text != nil)
    {
        [multiFunctionDisplayText setObject:text forKey:key];
    }
    else if (key != nil)
    {
        [multiFunctionDisplayText removeObjectForKey:key];
        // and blank any MFDs currently using it
        NSUInteger index;
        while ((index = [multiFunctionDisplaySettings indexOfObject:key]) != NSNotFound)
        {
            [multiFunctionDisplaySettings replaceObjectAtIndex:index withObject:[NSNull null]];
        }
    }
}

Referenced by PlayerShipSetMultiFunctionText().

Here is the caller graph for this function:

setName:

- (void) setName: (NSString *)  inName

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                :(NSString *)inName
{
    // Block super method; player ship can't be renamed.
}

setNextCompassMode

- (void) setNextCompassMode

Definition at line 13727 of file PlayerEntity.m.

{
    OOAegisStatus   aegis = AEGIS_NONE;
    Entity <OOBeaconEntity>     *beacon = nil;
    
    switch (compassMode)
    {
        case COMPASS_MODE_INACTIVE:
        case COMPASS_MODE_BASIC:
        case COMPASS_MODE_PLANET:
            aegis = [self checkForAegis];
            if ([UNIVERSE station] && (aegis == AEGIS_CLOSE_TO_MAIN_PLANET || aegis == AEGIS_IN_DOCKING_RANGE))
            { 
                [self setCompassMode:COMPASS_MODE_STATION];
            }
            else
            {
                [self setCompassMode:COMPASS_MODE_SUN];
            }
            break;
            
        case COMPASS_MODE_STATION:
            [self setCompassMode:COMPASS_MODE_SUN];
            break;
            
        case COMPASS_MODE_SUN:
            if ([self primaryTarget])
            {
                [self setCompassMode:COMPASS_MODE_TARGET];
                break;
            }
            // else fall through to switch to beacon mode.
            
        case COMPASS_MODE_TARGET:
            beacon = [UNIVERSE firstBeacon];
            while (beacon != nil && [beacon isJammingScanning])
            {
                beacon = [beacon nextBeacon];
            }
            [self setNextBeacon:beacon];
            
            if (beacon != nil)  [self setCompassMode:COMPASS_MODE_BEACONS];
            else  [self setCompassMode:COMPASS_MODE_PLANET];
            break;
 
        case COMPASS_MODE_BEACONS:
            beacon = [self nextBeacon];
            do
            {
                beacon = [beacon nextBeacon];
            } while (beacon != nil && [beacon isJammingScanning]);
            [self setNextBeacon:beacon];
            
            if (beacon == nil)
            {
                [self setCompassMode:COMPASS_MODE_PLANET];
            }
            break;
    }
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setNormalOrientation:

- (void) setNormalOrientation: (Quaternion)  quat

implementation

Reimplemented from Entity.

Definition at line 13727 of file PlayerEntity.m.

                             :(Quaternion) quat
{
    [self setOrientation:make_quaternion(-quat.w, quat.x, quat.y, quat.z)];
}

setOcclusionLevel:

- (void) setOcclusionLevel:

(float)

level

Definition at line 13727 of file PlayerEntity.m.

                          :(float)level
{
    occlusion_dial = level;
}

setPlanetinfo:

- (void) setPlanetinfo:

(NSString *)

key_valueString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                      :(NSString *)key_valueString  // uses key=value format
{
    NSArray *   tokens = [key_valueString componentsSeparatedByString:@"="];
    NSString*   keyString = nil;
    NSString*   valueString = nil;
 
    if ([tokens count] != 2)
    {
        OOLog(kOOLogSyntaxSetPlanetInfo, @"***** SCRIPT ERROR: in %@, CANNOT setPlanetinfo: '%@' (bad parameter count)", CurrentScriptDesc(), key_valueString);
        return;
    }
    
    keyString = [[tokens objectAtIndex:0] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
    valueString = [[tokens objectAtIndex:1] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
    
    /* Legacy script planetinfo settings are now non-persistent over save/load
     * Virtually nothing uses them any more, and expecting them to have a
     * manifest and identifying what it is if so seems unnecessary */
    [UNIVERSE setSystemDataKey:keyString value:valueString fromManifest:@""];
 
}

setPrevCompassMode

- (void) setPrevCompassMode

Definition at line 13727 of file PlayerEntity.m.

{
    OOAegisStatus   aegis = AEGIS_NONE;
    Entity <OOBeaconEntity>     *beacon = nil;
    
    switch (compassMode)
    {
        case COMPASS_MODE_INACTIVE:
        case COMPASS_MODE_BASIC:
        case COMPASS_MODE_PLANET:
            beacon = [UNIVERSE lastBeacon];
            while (beacon != nil && [beacon isJammingScanning])
            {
                beacon = [beacon prevBeacon];
            }
            [self setNextBeacon:beacon];
            
            if (beacon != nil)
            {
                [self setCompassMode:COMPASS_MODE_BEACONS];
                break;
            }
            // else fall through to switch to target mode.
 
        case COMPASS_MODE_BEACONS:
            beacon = [self nextBeacon];
            do
            {
                beacon = [beacon prevBeacon];
            } while (beacon != nil && [beacon isJammingScanning]);
            [self setNextBeacon:beacon];
            
            if (beacon == nil)
            {
                if ([self primaryTarget])
                {
                    [self setCompassMode:COMPASS_MODE_TARGET];
                }
                else
                {
                    [self setCompassMode:COMPASS_MODE_SUN];
                }
                break;
            }
            break;
 
        case COMPASS_MODE_TARGET:
            [self setCompassMode:COMPASS_MODE_SUN];
            break;
 
        case COMPASS_MODE_SUN:
            aegis = [self checkForAegis];
            if (aegis == AEGIS_CLOSE_TO_MAIN_PLANET || aegis == AEGIS_IN_DOCKING_RANGE)
            { 
                [self setCompassMode:COMPASS_MODE_STATION];
            }
            else
            {
                [self setCompassMode:COMPASS_MODE_PLANET];
            } 
            break;
 
        case COMPASS_MODE_STATION:
            [self setCompassMode:COMPASS_MODE_PLANET];
            break;
    }
}

setPreviousSystemID:

- (void) setPreviousSystemID:

(OOSystemID)

sid

Definition at line 13727 of file PlayerEntity.m.

                            :(OOSystemID) sid
{
    previous_system_id = sid;
}

setPrimedEquipment:showMessage:

- (BOOL) setPrimedEquipment:		(NSString *)	eqKey
showMessage:		(BOOL)	showMsg

Definition at line 13727 of file PlayerEntity.m.

                           :(NSString *)eqKey showMessage:(BOOL)showMsg
{
    NSUInteger c = [eqScripts count];
    NSUInteger current = primedEquipment;
    primedEquipment = [self eqScriptIndexForKey:eqKey]; // if key not found primedEquipment is set to primed-none
    BOOL unprimeEq = [eqKey isEqualToString:@""];
    BOOL result = YES;
 
    if (primedEquipment == c && !unprimeEq)
    {
        primedEquipment = current;
        result = NO;
    }
    else 
    {
        if (primedEquipment != current && showMsg == YES)
        {
            NSString *equipmentName = [[OOEquipmentType equipmentTypeWithIdentifier:[[eqScripts oo_arrayAtIndex:primedEquipment] oo_stringAtIndex:0]] name];
            [UNIVERSE addMessage:unprimeEq ? OOExpandKey(@"equipment-primed-none") : OOExpandKey(@"equipment-primed", equipmentName) forCount:2.0];
        }
    }
    return result;
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setRandom_factor:

- (void) setRandom_factor:

(int)

rf

Definition at line 13727 of file PlayerEntity.m.

                         :(int)rf
{
    market_rnd = rf;
}

setScoopOverride:

- (void) setScoopOverride:

(BOOL)

newValue

Definition at line 9242 of file PlayerEntity.m.

                         :(BOOL)newValue
{
    scoopOverride = !!newValue;
    if (scoopOverride)  [self setScoopsActive];
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

setScoopsActive

- (void) setScoopsActive

Definition at line 9242 of file PlayerEntity.m.

{
    scoopsActive = YES;
}

setScore:

- (void) setScore:

(unsigned)

value

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                 :(unsigned)value
{
    ship_kills = value;
}

Referenced by PlayerSetProperty().

Here is the caller graph for this function:

setScriptTarget:

- (void) setScriptTarget:

(ShipEntity *)

ship

Provided by category PlayerEntity(Scripting).

Definition at line 233 of file PlayerEntityLegacyScriptEngine.m.

                        :(ShipEntity *)ship
{
    scriptTarget = ship;
}

Referenced by OOPlayerForScripting(), and ShipRunLegacyScriptActions().

Here is the caller graph for this function:

setShowDemoShips:

- (void) setShowDemoShips:

(BOOL)

value

Definition at line 13727 of file PlayerEntity.m.

                         :(BOOL)value
{
    showDemoShips = value;
}

setSpecificPlanetInfo:

- (void) setSpecificPlanetInfo:

(NSString *)

key_valueString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                              :(NSString *)key_valueString  // uses galaxy#=planet#=key=value
{
    NSArray *   tokens = [key_valueString componentsSeparatedByString:@"="];
    NSString*   keyString = nil;
    NSString*   valueString = nil;
    int gnum, pnum;
 
    if ([tokens count] != 4)
    {
        OOLog(kOOLogSyntaxSetPlanetInfo, @"***** SCRIPT ERROR: in %@, CANNOT setSpecificPlanetInfo: '%@' (bad parameter count)", CurrentScriptDesc(), key_valueString);
        return;
    }
 
    gnum = [tokens oo_intAtIndex:0];
    pnum = [tokens oo_intAtIndex:1];
    keyString = [[tokens objectAtIndex:2] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
    valueString = [[tokens objectAtIndex:3] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
 
    [UNIVERSE setSystemDataForGalaxy:gnum planet:pnum key:keyString value:valueString fromManifest:@"" forLayer:OO_LAYER_OXP_DYNAMIC];
}

setSunNovaIn:

- (void) setSunNovaIn:

(NSString *)

time_value

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                     :(NSString *)time_value
{
    double time_until_nova = [time_value doubleValue];
    [[UNIVERSE sun] setGoingNova:YES inTime: time_until_nova];
}

setSystemID:

- (void) setSystemID:

(OOSystemID)

sid

Definition at line 13727 of file PlayerEntity.m.

                    :(OOSystemID) sid
{
    system_id = sid;
    galaxy_coordinates = PointFromString([[UNIVERSE systemManager] getProperty:@"coordinates" forSystem:sid inGalaxy:galaxy_number]);
    chart_centre_coordinates = galaxy_coordinates;
    target_chart_centre = chart_centre_coordinates;
}

setTargetDockStationTo:

- (void) setTargetDockStationTo:

(StationEntity *)

value

Definition at line 13727 of file PlayerEntity.m.

                               :(StationEntity *) value
{
    targetDockStation = value;
}

setTargetSystemID:

- (void) setTargetSystemID:

(OOSystemID)

sid

Definition at line 13727 of file PlayerEntity.m.

                          :(OOSystemID) sid
{
    target_system_id = sid;
    cursor_coordinates = PointFromString([[UNIVERSE systemManager] getProperty:@"coordinates" forSystemKey:[UNIVERSE keyForPlanetOverridesForSystem:sid inGalaxy:galaxy_number]]);
}

Referenced by PlayerSetEscapePodDestination(), and PlayerShipSetProperty().

Here is the caller graph for this function:

setTrumbleAppetiteAccumulator:

- (void) setTrumbleAppetiteAccumulator:

(float)

value

Definition at line 9242 of file PlayerEntity.m.

                                      :(float)value
{
    _trumbleAppetiteAccumulator = value;
}

setTrumbleValueFrom:

- (void) setTrumbleValueFrom:

(NSObject *)

trumbleValue

Definition at line 9242 of file PlayerEntity.m.

                            :(NSObject*) trumbleValue
{
    BOOL info_failed = NO;
    int trumbleHash;
    int putativeHash = 0;
    int putativeNTrumbles = 0;
    NSArray *putativeTrumbleArray = nil;
    int i;
    NSString *namekey = [NSString stringWithFormat:@"%@-humbletrash", [self commanderName]];
    
    [self setUpTrumbles];
    
    if (trumbleValue)
    {
        BOOL possible_cheat = NO;
        if (![trumbleValue isKindOfClass:[NSArray class]])
            info_failed = YES;
        else
        {
            NSArray* values = (NSArray*) trumbleValue;
            if ([values count] >= 1)
                putativeNTrumbles = [values oo_intAtIndex:0];
            if ([values count] >= 2)
                putativeHash = [values oo_intAtIndex:1];
            if ([values count] >= 3)
                putativeTrumbleArray = [values oo_arrayAtIndex:2];
        }
        // calculate a hash for the putative values
        clear_checksum();
        [self mungChecksumWithNSString:[self commanderName]];
        munge_checksum(credits);
        munge_checksum(ship_kills);
        trumbleHash = munge_checksum(putativeNTrumbles);
        
        if (putativeHash != trumbleHash)
            info_failed = YES;
        
        if (info_failed)
        {
            OOLog(@"cheat.tentative", @"%@", @"POSSIBLE CHEAT DETECTED");
            possible_cheat = YES;
        }
        
        for (i = 1; (info_failed)&&(i < PLAYER_MAX_TRUMBLES); i++)
        {
            // try to determine trumbleCount from the key in the saved game
            clear_checksum();
            [self mungChecksumWithNSString:[self commanderName]];
            munge_checksum(credits);
            munge_checksum(ship_kills);
            trumbleHash = munge_checksum(i);
            if (putativeHash == trumbleHash)
            {
                info_failed = NO;
                putativeNTrumbles = i;
            }
        }
        
        if (possible_cheat && !info_failed)
            OOLog(@"cheat.verified", @"%@", @"CHEAT DEFEATED - that's not the way to get rid of trumbles!");
    }
    else
    // if trumbleValue comes in as nil, then probably someone has toyed with the save file
    // by removing the entire trumbles array
    {
        OOLog(@"cheat.tentative", @"%@", @"POSSIBLE CHEAT DETECTED");
        info_failed = YES;
    }
    
    if (info_failed && [[NSUserDefaults standardUserDefaults] objectForKey:namekey])
    {
        // try to determine trumbleCount from the key in user defaults
        putativeHash = (int)[[NSUserDefaults standardUserDefaults] integerForKey:namekey];
        for (i = 1; (info_failed)&&(i < PLAYER_MAX_TRUMBLES); i++)
        {
            clear_checksum();
            [self mungChecksumWithNSString:[self commanderName]];
            munge_checksum(credits);
            munge_checksum(ship_kills);
            trumbleHash = munge_checksum(i);
            if (putativeHash == trumbleHash)
            {
                info_failed = NO;
                putativeNTrumbles = i;
            }
        }
        
        if (!info_failed)
            OOLog(@"cheat.verified", @"%@", @"CHEAT DEFEATED - that's not the way to get rid of trumbles!");
    }
    // at this stage we've done the best we can to stop cheaters
    trumbleCount = putativeNTrumbles;
 
    if ((putativeTrumbleArray != nil) && ([putativeTrumbleArray count] == PLAYER_MAX_TRUMBLES))
    {
        for (i = 0; i < PLAYER_MAX_TRUMBLES; i++)
            [trumble[i] setFromDictionary:[putativeTrumbleArray oo_dictionaryAtIndex:i]];
    }
    
    clear_checksum();
    [self mungChecksumWithNSString:[self commanderName]];
    munge_checksum(credits);
    munge_checksum(ship_kills);
    trumbleHash = munge_checksum(trumbleCount);
    
    [[NSUserDefaults standardUserDefaults]  setInteger:trumbleHash forKey:namekey];
}

setUpAndConfirmOK:

- (BOOL) setUpAndConfirmOK:

(BOOL)

stopOnError

Definition at line 13727 of file PlayerEntity.m.

                          :(BOOL)stopOnError
{
    return [self setUpAndConfirmOK:stopOnError saveGame:NO];
}

setUpAndConfirmOK:saveGame:

- (BOOL) setUpAndConfirmOK:		(BOOL)	stopOnError
saveGame:		(BOOL)	loadingGame

Definition at line 13727 of file PlayerEntity.m.

                          :(BOOL)stopOnError saveGame:(BOOL)saveGame
{
    fieldOfView = [[UNIVERSE gameView] fov:YES];
    unsigned i;
    
    showDemoShips = NO;
    show_info_flag = NO;
    DESTROY(marketSelectedCommodity);
    
    // Reset JavaScript.
    [OOScriptTimer noteGameReset];
    [OOScriptTimer updateTimers];
    
    GameController      *gc = [[UNIVERSE gameView] gameController];
    
    if (![gc inFullScreenMode] && stopOnError)  [gc stopAnimationTimer];    // start of critical section
    
    if (EXPECT_NOT(![[OOJavaScriptEngine sharedEngine] reset] && stopOnError)) // always (try to) reset the engine, then find out if we need to stop.
    {
        /*
            Occasionally there's a racing condition between timers being deleted
            and the js engine needing to be reset: the engine reset stops the timers
            from being deleted, and undeleted timers don't allow the engine to reset
            itself properly.
            
            If the engine can't reset, let's give ourselves an extra 20ms to allow the
            timers to delete themselves.
            
            We'll piggyback performDeadUpdates: when STATUS_DEAD, the engine waits until 
            kDeadResetTime then restarts Oolite via [UNIVERSE updateGameOver]
            The variable shot_time is used to keep track of how long ago we were
            shot.
            
            If we're loading a savegame the code will try a new JS reset immediately
            after failing this reset...
        */
        
        // set up STATUS_DEAD
        [self setDockedStation:nil];    // needed for STATUS_DEAD
        [self setStatus:STATUS_DEAD];
        OOLog(@"script.javascript.init.error", @"%@", @"Scheduling new JavaScript reset.");
        shot_time = kDeadResetTime - 0.02f; // schedule reinit 20 milliseconds from now.
        
        if (![gc inFullScreenMode]) [gc startAnimationTimer];   // keep the game ticking over.
        return NO;
    }
    
    // end of critical section
    if (![gc inFullScreenMode] && stopOnError)  [gc startAnimationTimer];
    
    // Load locale script before any regular scripts.
    [OOJSScript jsScriptFromFileNamed:@"oolite-locale-functions.js"
                           properties:nil];
    
    [[GameController sharedController] logProgress:DESC(@"loading-scripts")];
    
    [UNIVERSE setBlockJSPlayerShipProps:NO];    // full access to player.ship properties!
    DESTROY(worldScripts);
    DESTROY(worldScriptsRequiringTickle);
    DESTROY(commodityScripts);
 
#if OOLITE_WINDOWS
    if (saveGame)
    {
        [UNIVERSE preloadSounds];
        [self setUpSound];
        worldScripts = [[ResourceManager loadScripts] retain];
        [UNIVERSE loadConditionScripts];
        commodityScripts = [[NSMutableDictionary alloc] init];
    }
#else
    /* on OSes that allow safe deletion of open files, can use sounds
     * on the OXZ screen and other start screens */
    [UNIVERSE preloadSounds];
    [self setUpSound];
    if (saveGame)
    {
        worldScripts = [[ResourceManager loadScripts] retain];
        [UNIVERSE loadConditionScripts];
        commodityScripts = [[NSMutableDictionary alloc] init];
    }
#endif
 
    // make sure extraGuiScreenKeys is clear
    DESTROY(extraGuiScreenKeys);
 
    [[GameController sharedController] logProgress:OOExpandKeyRandomized(@"loading-miscellany")];
    
    // if there is cargo remaining from previously (e.g. a game restart), remove it
    if ([self cargoList] != nil)
    {
        [self removeAllCargo:YES];      // force removal of cargo
    }
    
    [self setShipDataKey:PLAYER_SHIP_DESC];
    ship_trade_in_factor = 95;
    
    // reset HUD & default commlog behaviour
    [UNIVERSE setAutoCommLog:YES];
    [UNIVERSE setPermanentCommLog:NO];
    
    [multiFunctionDisplayText release];
    multiFunctionDisplayText = [[NSMutableDictionary alloc] init];
 
    [multiFunctionDisplaySettings release];
    multiFunctionDisplaySettings = [[NSMutableArray alloc] init];
 
    [customDialSettings release];
    customDialSettings = [[NSMutableDictionary alloc] init];
 
    [self switchHudTo:@"hud.plist"];    
    scanner_zoom_rate = 0.0f;
    longRangeChartMode = OOLRC_MODE_SUNCOLOR;
 
    [mission_variables release];
    mission_variables = [[NSMutableDictionary alloc] init];
    
    [localVariables release];
    localVariables = [[NSMutableDictionary alloc] init];
    
    [self setScriptTarget:nil];
    [self resetMissionChoice];
    [[UNIVERSE gameView] resetTypedString];
    found_system_id = -1;
    
    [reputation release];
    reputation = [[NSMutableDictionary alloc] initWithCapacity:6];
    [reputation oo_setInteger:0 forKey:CONTRACTS_GOOD_KEY];
    [reputation oo_setInteger:0 forKey:CONTRACTS_BAD_KEY];
    [reputation oo_setInteger:MAX_CONTRACT_REP forKey:CONTRACTS_UNKNOWN_KEY];
    [reputation oo_setInteger:0 forKey:PASSAGE_GOOD_KEY];
    [reputation oo_setInteger:0 forKey:PASSAGE_BAD_KEY];
    [reputation oo_setInteger:MAX_CONTRACT_REP forKey:PASSAGE_UNKNOWN_KEY];
    [reputation oo_setInteger:0 forKey:PARCEL_GOOD_KEY];
    [reputation oo_setInteger:0 forKey:PARCEL_BAD_KEY];
    [reputation oo_setInteger:MAX_CONTRACT_REP forKey:PARCEL_UNKNOWN_KEY];
    
    DESTROY(roleWeights);
    roleWeights = [[NSMutableArray alloc] initWithCapacity:8];
    for (i = 0 ; i < 8 ; i++)
    {
        [roleWeights addObject:@"player-unknown"];
    }
    DESTROY(roleWeightFlags);
    roleWeightFlags = [[NSMutableDictionary alloc] init];
 
    DESTROY(roleSystemList);
    roleSystemList = [[NSMutableArray alloc] initWithCapacity:32];
 
    energy                  = 256;
    weapon_temp             = 0.0f;
    forward_weapon_temp     = 0.0f;
    aft_weapon_temp         = 0.0f;
    port_weapon_temp        = 0.0f;
    starboard_weapon_temp   = 0.0f;
    lastShot = nil;
    forward_shot_time       = INITIAL_SHOT_TIME;
    aft_shot_time           = INITIAL_SHOT_TIME;
    port_shot_time          = INITIAL_SHOT_TIME;
    starboard_shot_time     = INITIAL_SHOT_TIME;
    ship_temperature        = 60.0f;
    alertFlags              = 0;
    hyperspeed_engaged      = NO;
    autopilot_engaged = NO;
    velocity = kZeroVector;
    
    flightRoll = 0.0f;
    flightPitch = 0.0f;
    flightYaw = 0.0f;
 
    max_passengers = 0;
    [passengers release];
    passengers = [[NSMutableArray alloc] init];
    [passenger_record release];
    passenger_record = [[NSMutableDictionary alloc] init];
    
    [contracts release];
    contracts = [[NSMutableArray alloc] init];
    [contract_record release];
    contract_record = [[NSMutableDictionary alloc] init];
 
    [parcels release];
    parcels = [[NSMutableArray alloc] init];
    [parcel_record release];
    parcel_record = [[NSMutableDictionary alloc] init];
    
    [missionDestinations release];
    missionDestinations = [[NSMutableDictionary alloc] init];
    
    [shipyard_record release];
    shipyard_record = [[NSMutableDictionary alloc] init];
    
    [target_memory release];
    target_memory = [[NSMutableArray alloc] initWithCapacity:PLAYER_TARGET_MEMORY_SIZE];
    [self clearTargetMemory]; // also does first-time initialisation
 
    [self setMissionOverlayDescriptor:nil];
    [self setMissionBackgroundDescriptor:nil];
    [self setMissionBackgroundSpecial:nil];
    [self setEquipScreenBackgroundDescriptor:nil];
    marketOffset = 0;
    DESTROY(marketSelectedCommodity);
 
    script_time = 0.0;
    script_time_check = SCRIPT_TIMER_INTERVAL;
    script_time_interval = SCRIPT_TIMER_INTERVAL;
    
    NSCalendarDate *nowDate = [NSCalendarDate calendarDate];
    ship_clock = PLAYER_SHIP_CLOCK_START;
    ship_clock += [nowDate hourOfDay] * 3600.0;
    ship_clock += [nowDate minuteOfHour] * 60.0;
    ship_clock += [nowDate secondOfMinute];
    fps_check_time = ship_clock;
    ship_clock_adjust = 0.0;
    escape_pod_rescue_time = 0.0;
 
    isSpeechOn = OOSPEECHSETTINGS_OFF;
#if OOLITE_ESPEAK
    voice_gender_m = YES;
    voice_no = [UNIVERSE setVoice:-1 withGenderM:voice_gender_m];
#endif
    
    [_customViews release];
    _customViews = nil;
    _customViewIndex = 0;
    
    mouse_control_on = NO;
    
    // player commander data
    // Most of this is probably also set more than once
    
    [self setCommanderName:PLAYER_DEFAULT_NAME];
    [self setLastsaveName:PLAYER_DEFAULT_NAME];
    
    galaxy_coordinates      = NSMakePoint(0x14,0xAD);   // 20,173
 
    credits                 = 1000;
    fuel                    = PLAYER_MAX_FUEL;
    fuel_accumulator        = 0.0f;
    fuel_leak_rate          = 0.0f;
    
    galaxy_number           = 0;
    // will load real weapon data later
    forward_weapon_type     = nil;
    aft_weapon_type         = nil;
    port_weapon_type        = nil;
    starboard_weapon_type   = nil;
    scannerRange = (float)SCANNER_MAX_RANGE; 
    
    weapons_online          = YES;
    
    ecm_in_operation = NO;
    last_ecm_time = [UNIVERSE getTime];
    compassMode = COMPASS_MODE_BASIC;
    ident_engaged = NO;
    
    max_cargo               = 20; // will be reset later
    marketFilterMode        = MARKET_FILTER_MODE_OFF;
    
    DESTROY(shipCommodityData);
    shipCommodityData = [[[UNIVERSE commodities] generateManifestForPlayer] retain];
    
    // set up missiles
    missiles                = PLAYER_STARTING_MISSILES;
    max_missiles            = PLAYER_STARTING_MAX_MISSILES;
    
    [eqScripts release];
    eqScripts = [[NSMutableArray alloc] init];
    primedEquipment = 0;
    [self setFastEquipmentA:@"EQ_CLOAKING_DEVICE"];
    [self setFastEquipmentB:@"EQ_ENERGY_BOMB"]; // for compatibility purposes
 
    [self setActiveMissile:0];
    for (i = 0; i < missiles; i++)
    {
        [missile_entity[i] release];
        missile_entity[i] = nil;
    }
    [self safeAllMissiles];
    
    [self clearSubEntities];
    
    legalStatus             = 0;
    
    market_rnd              = 0;
    ship_kills              = 0;
    chart_centre_coordinates    = galaxy_coordinates;
    target_chart_centre     = chart_centre_coordinates;
    cursor_coordinates      = galaxy_coordinates;
    chart_focus_coordinates     = cursor_coordinates;
    target_chart_focus      = chart_focus_coordinates;
    chart_zoom          = 1.0;
    target_chart_zoom       = 1.0;
    saved_chart_zoom        = 1.0;
    ANA_mode            = OPTIMIZED_BY_NONE;
 
    
    scripted_misjump        = NO;
    _scriptedMisjumpRange   = 0.5;
    scoopOverride           = NO;
    
    max_forward_shield      = BASELINE_SHIELD_LEVEL;
    max_aft_shield          = BASELINE_SHIELD_LEVEL;
 
    forward_shield_recharge_rate    = 2.0;
    aft_shield_recharge_rate        = 2.0;
 
    forward_shield          = [self maxForwardShieldLevel];
    aft_shield              = [self maxAftShieldLevel];
    
    scanClass               = CLASS_PLAYER;
    
    [UNIVERSE clearGUIs];
    
    dockingClearanceStatus = DOCKING_CLEARANCE_STATUS_GRANTED;
    targetDockStation = nil;
    
    [self setDockedStation:[UNIVERSE station]];
    
    [commLog release];
    commLog = nil;
    
    [specialCargo release];
    specialCargo = nil;
    
    // views
    forwardViewOffset       = kZeroVector;
    aftViewOffset           = kZeroVector;
    portViewOffset          = kZeroVector;
    starboardViewOffset     = kZeroVector;
    customViewOffset        = kZeroVector;
    
    currentWeaponFacing     = WEAPON_FACING_FORWARD;
    [self currentWeaponStats];
    
    [save_path autorelease];
    save_path = nil;
    
    [scannedWormholes release];
    scannedWormholes = [[NSMutableArray alloc] init];
    
    [self setUpTrumbles];
    
    suppressTargetLost = NO;
    
    scoopsActive = NO;
    
    [dockingReport release];
    dockingReport = [[NSMutableString alloc] init];
    
    [shipAI release];
    shipAI = [[AI alloc] initWithStateMachine:PLAYER_DOCKING_AI_NAME andState:@"GLOBAL"];
    [self resetAutopilotAI];
    
    lastScriptAlertCondition = [self alertCondition];
    
    entity_personality = ranrot_rand() & 0x7FFF;
    
    [self setSystemID:[UNIVERSE findSystemNumberAtCoords:[self galaxy_coordinates] withGalaxy:galaxy_number includingHidden:YES]];
    [UNIVERSE setGalaxyTo:galaxy_number];
    [UNIVERSE setSystemTo:system_id];
 
    [self setUpWeaponSounds];
    
    [self setGalacticHyperspaceBehaviourTo:[[UNIVERSE globalSettings] oo_stringForKey:@"galactic_hyperspace_behaviour" defaultValue:@"BEHAVIOUR_STANDARD"]];
    [self setGalacticHyperspaceFixedCoordsTo:[[UNIVERSE globalSettings] oo_stringForKey:@"galactic_hyperspace_fixed_coords" defaultValue:@"96 96"]];
    
    cloaking_device_active = NO;
 
    demoShip = nil;
    
    [[OOMusicController sharedController] justStop];
    [stickProfileScreen release];
    stickProfileScreen = [[StickProfileScreen alloc] init];
    return YES;
}

setUpShipFromDictionary:

- (BOOL) setUpShipFromDictionary: (NSDictionary *)  shipDict

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                                :(NSDictionary *)shipDict
{
    DESTROY(compassTarget);
    [UNIVERSE setBlockJSPlayerShipProps:NO];    // full access to player.ship properties!
    
    if (![super setUpFromDictionary:shipDict]) return NO;
    
    DESTROY(cargo);
    cargo = [[NSMutableArray alloc] initWithCapacity:max_cargo];
 
    // Player-only settings.
    //
    // set control factors..
    roll_delta =        2.0f * max_flight_roll;
    pitch_delta =       2.0f * max_flight_pitch;
    yaw_delta =         2.0f * max_flight_yaw;
    
    energy = maxEnergy;
    //if (forward_weapon_type == WEAPON_NONE) [self setWeaponDataFromType:forward_weapon_type]; 
    scannerRange = (float)SCANNER_MAX_RANGE; 
    
    [roleSet release];
    roleSet = nil;
    [self setPrimaryRole:@"player"];
    
    [self removeAllEquipment];
    [self addEquipmentFromCollection:[shipDict objectForKey:@"extra_equipment"]];
 
    [self resetHud];
    [hud setHidden:NO];
    
    // set up missiles
    // sanity check the number of missiles...
    if (max_missiles > PLAYER_MAX_MISSILES)  max_missiles = PLAYER_MAX_MISSILES;
    if (missiles > max_missiles)  missiles = max_missiles;
    // end sanity check
 
    unsigned i;
    for (i = 0; i < PLAYER_MAX_MISSILES; i++)
    {
        [missile_entity[i] release];
        missile_entity[i] = nil;
    }
    for (i = 0; i < missiles; i++)
    {
        missile_list[i] = [OOEquipmentType equipmentTypeWithIdentifier:@"EQ_MISSILE"];
        missile_entity[i] = [UNIVERSE newShipWithRole:@"EQ_MISSILE"];   // retain count = 1
    }
    
    DESTROY(_primaryTarget);
    [self safeAllMissiles];
    [self setActiveMissile:0];
    
    // set view offsets
    [self setDefaultViewOffsets];
    
    if (EXPECT(_scaleFactor == 1.0f))
    {
        forwardViewOffset = [shipDict oo_vectorForKey:@"view_position_forward" defaultValue:forwardViewOffset];
        aftViewOffset = [shipDict oo_vectorForKey:@"view_position_aft" defaultValue:aftViewOffset];
        portViewOffset = [shipDict oo_vectorForKey:@"view_position_port" defaultValue:portViewOffset];
        starboardViewOffset = [shipDict oo_vectorForKey:@"view_position_starboard" defaultValue:starboardViewOffset];
    }
    else
    {
        forwardViewOffset = vector_multiply_scalar([shipDict oo_vectorForKey:@"view_position_forward" defaultValue:forwardViewOffset],_scaleFactor);
        aftViewOffset = vector_multiply_scalar([shipDict oo_vectorForKey:@"view_position_aft" defaultValue:aftViewOffset],_scaleFactor);
        portViewOffset = vector_multiply_scalar([shipDict oo_vectorForKey:@"view_position_port" defaultValue:portViewOffset],_scaleFactor);
        starboardViewOffset = vector_multiply_scalar([shipDict oo_vectorForKey:@"view_position_starboard" defaultValue:starboardViewOffset],_scaleFactor);
    }
 
    [self setDefaultCustomViews];
    
    NSArray *customViews = [shipDict oo_arrayForKey:@"custom_views"];
    if (customViews != nil)
    {
        [_customViews release];
        _customViews = [customViews retain];
        _customViewIndex = 0;
    }
    
    massLockable = [shipDict oo_boolForKey:@"mass_lockable" defaultValue:YES];
    
    // Load js script
    [script autorelease];
    NSDictionary *scriptProperties = [NSDictionary dictionaryWithObject:self forKey:@"ship"];
    script = [OOScript jsScriptFromFileNamed:[shipDict oo_stringForKey:@"script"] 
                                         properties:scriptProperties];
    if (script == nil)
    {
        // Do not switch to using a default value above; we want to use the default script if loading fails.
        script = [OOScript jsScriptFromFileNamed:@"oolite-default-player-script.js"
                                             properties:scriptProperties];
    }
    [script retain];
    
    return YES;
}

setUpSound

- (void) setUpSound

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    [self destroySound];
    
    sInterfaceBeepSource = [[OOSoundSource alloc] init];
    [sInterfaceBeepSource setPosition:kInterfaceBeepPosition];
 
    sBreakPatternSource = [[OOSoundSource alloc] init];
    [sBreakPatternSource setPosition:kBreakPatternPosition];
 
    sEcmSource = [[OOSoundSource alloc] init];
    [sEcmSource setPosition:kEcmPosition];
 
    sHyperspaceSoundSource = [[OOSoundSource alloc] init];
    [sHyperspaceSoundSource setPosition:kWitchspacePosition];
    
    sBuySellSourcePool = [[OOSoundSourcePool alloc] initWithCount:kBuySellSourcePoolSize minRepeatTime:0.0];
    sWarningSoundPool = [[OOSoundSourcePool alloc] initWithCount:kWarningPoolSize minRepeatTime:0.0];
    sWeaponSoundPool = [[OOSoundSourcePool alloc] initWithCount:kWeaponPoolSize minRepeatTime:0.0];
    sDamageSoundPool = [[OOSoundSourcePool alloc] initWithCount:kDamagePoolSize minRepeatTime:0.1]; // Repeat time limit is to avoid playing a scrape sound every frame on glancing scrapes. This does limit the number of laser hits that can be played in a furrball, though; maybe lasers and scrapes should use different pools.
    sMiscSoundPool = [[OOSoundSourcePool alloc] initWithCount:kMiscPoolSize minRepeatTime:0.0];
    
    // Two sources with the same sound are used to simulate looping.
    OOSound *afterburnerSound = [ResourceManager ooSoundNamed:@"afterburner1.ogg" inFolder:@"Sounds"];
    sAfterburnerSources[0] = [[OOSoundSource alloc] initWithSound:afterburnerSound];
    [sAfterburnerSources[0] setPosition:kAfterburner1Position];
    sAfterburnerSources[1] = [[OOSoundSource alloc] initWithSound:afterburnerSound];
    [sAfterburnerSources[1] setPosition:kAfterburner2Position];
}

setupStartScreenGui

- (void) setupStartScreenGui

Definition at line 9242 of file PlayerEntity.m.

{
    GuiDisplayGen   *gui = [UNIVERSE gui];
    NSString        *text = nil;
 
    [[UNIVERSE gameController] setMouseInteractionModeForUIWithMouseInteraction:YES];
 
    [gui clear];
 
    [gui setTitle:@"Oolite"];
 
    text = DESC(@"game-copyright");
    [gui setText:text forRow:15 align:GUI_ALIGN_CENTER];
    [gui setColor:[OOColor whiteColor] forRow:15];
        
    text = DESC(@"theme-music-credit");
    [gui setText:text forRow:17 align:GUI_ALIGN_CENTER];
    [gui setColor:[OOColor grayColor] forRow:17];
        
    int initialRow = 22;
    int row = initialRow;
 
    text = DESC(@"oolite-start-option-1");
    [gui setText:text forRow:row align:GUI_ALIGN_CENTER];
    [gui setColor:[OOColor yellowColor] forRow:row];
    [gui setKey:[NSString stringWithFormat:@"Start:%d", row] forRow:row];
 
    ++row;
 
    text = DESC(@"oolite-start-option-2");
    [gui setText:text forRow:row align:GUI_ALIGN_CENTER];
    [gui setColor:[OOColor yellowColor] forRow:row];
    [gui setKey:[NSString stringWithFormat:@"Start:%d", row] forRow:row];
 
    ++row;
 
    text = DESC(@"oolite-start-option-3");
    [gui setText:text forRow:row align:GUI_ALIGN_CENTER];
    [gui setColor:[OOColor yellowColor] forRow:row];
    [gui setKey:[NSString stringWithFormat:@"Start:%d", row] forRow:row];
 
    ++row;
 
    text = DESC(@"oolite-start-option-4");
    [gui setText:text forRow:row align:GUI_ALIGN_CENTER];
    [gui setColor:[OOColor yellowColor] forRow:row];
    [gui setKey:[NSString stringWithFormat:@"Start:%d", row] forRow:row];
 
    ++row;
 
    text = DESC(@"oolite-start-option-5");
    [gui setText:text forRow:row align:GUI_ALIGN_CENTER];
    [gui setColor:[OOColor yellowColor] forRow:row];
    [gui setKey:[NSString stringWithFormat:@"Start:%d", row] forRow:row];
 
    ++row;
 
    text = DESC(@"oolite-start-option-6");
    [gui setText:text forRow:row align:GUI_ALIGN_CENTER];
    [gui setColor:[OOColor yellowColor] forRow:row];
    [gui setKey:[NSString stringWithFormat:@"Start:%d", row] forRow:row];
 
 
    [gui setSelectableRange:NSMakeRange(initialRow, row - initialRow + 1)];
    [gui setSelectedRow:initialRow];
 
    [gui setBackgroundTextureKey:@"intro"];
 
}

setUpTrumbles

- (void) setUpTrumbles

Definition at line 9242 of file PlayerEntity.m.

{
    NSMutableString *trumbleDigrams = [NSMutableString stringWithCapacity:256];
    unichar xchar = (unichar)0;
    unichar digramchars[2];
 
    while ([trumbleDigrams length] < PLAYER_MAX_TRUMBLES + 2)
    {
        NSString *commanderName = [self commanderName];
        if ([commanderName length] > 0)
        {
            [trumbleDigrams appendFormat:@"%@%@", commanderName, [[self mesh] modelName]];
        }
        else
        {
            [trumbleDigrams appendString:@"Some Random Text!"];
        }
    }
    int i;
    for (i = 0; i < PLAYER_MAX_TRUMBLES; i++)
    {
        digramchars[0] = ([trumbleDigrams characterAtIndex:i] & 0x007f) | 0x0020;
        digramchars[1] = (([trumbleDigrams characterAtIndex:i + 1] ^ xchar) & 0x007f) | 0x0020;
        xchar = digramchars[0];
        NSString *digramstring = [NSString stringWithCharacters:digramchars length:2];
        [trumble[i] release];
        trumble[i] = [[OOTrumble alloc] initForPlayer:self digram:digramstring];
    }
    
    trumbleCount = 0;
    
    [self setTrumbleAppetiteAccumulator:0.0f];
}

setUpWeaponSounds

- (void) setUpWeaponSounds

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    NSArray             *eqTypes = [OOEquipmentType allEquipmentTypes];
    NSMutableDictionary *shotMissSounds = [NSMutableDictionary dictionary];
    NSMutableDictionary *shotHitSounds = [NSMutableDictionary dictionary];
    NSMutableDictionary *shieldHitSounds = [NSMutableDictionary dictionary];
    NSMutableDictionary *unshieldedHitSounds = [NSMutableDictionary dictionary];
    NSMutableDictionary *weaponLaunchedSounds = [NSMutableDictionary dictionary];
    NSEnumerator        *eqTypeEnum = nil;
    OOEquipmentType     *eqType = nil;
 
    // special case: turrets aren't defined with a "EQ_WEAPON" prefix, and plasma shots don't have a matching equipment item, 
    // so add a unique entry here. this could be overridden if an OXP creates an equipment item with this key.
    // plasma shots don't make a sound when fired, so we only need to provide for the hit player sound keys.
    [shieldHitSounds setObject:@"[player-hit-by-weapon]" forKey:@"EQ_WEAPON_PLASMA_SHOT"];
    [unshieldedHitSounds setObject:@"[player-direct-hit]" forKey:@"EQ_WEAPON_PLASMA_SHOT"];
    // grab a local copy of the sound identifiers for weapons to make the process of looking up a sound ref as fast as possible
    // but we must ensure that no nil values are used for setObject
    #define OO_ASSIGN_SOUNDSTR_TO_SOUNDS(soundStr, sounds) do { \
        fxString = [eqType soundStr]; \
        if (!fxString)  fxString = @""; \
        [sounds setObject:fxString forKey:[eqType identifier]]; \
    } while(0)
        
    for (eqTypeEnum = [eqTypes objectEnumerator]; (eqType = [eqTypeEnum nextObject]); )
    {
        NSString *fxString = nil;
        if ([[eqType identifier] hasPrefix:@"EQ_WEAPON"]) 
        {
            OO_ASSIGN_SOUNDSTR_TO_SOUNDS(fxShotMissName, shotMissSounds);
            OO_ASSIGN_SOUNDSTR_TO_SOUNDS(fxShotHitName, shotHitSounds);
            OO_ASSIGN_SOUNDSTR_TO_SOUNDS(fxShieldHitName, shieldHitSounds);
            OO_ASSIGN_SOUNDSTR_TO_SOUNDS(fxUnshieldedHitName, unshieldedHitSounds);
        }
        if ([eqType isMissileOrMine]) 
        {
            OO_ASSIGN_SOUNDSTR_TO_SOUNDS(fxWeaponLaunchedName, weaponLaunchedSounds);
            OO_ASSIGN_SOUNDSTR_TO_SOUNDS(fxShieldHitName, shieldHitSounds);
            OO_ASSIGN_SOUNDSTR_TO_SOUNDS(fxUnshieldedHitName, unshieldedHitSounds);
        }
    }
 
    DESTROY(weaponShotMiss);
    DESTROY(weaponShotHit);
    DESTROY(weaponShieldHit);
    DESTROY(weaponUnshieldedHit);
    DESTROY(weaponLaunched);
 
    weaponShotMiss = [[NSDictionary alloc] initWithDictionary:shotMissSounds];
    weaponShotHit = [[NSDictionary alloc] initWithDictionary:shotHitSounds];
    weaponShieldHit = [[NSDictionary alloc] initWithDictionary:shieldHitSounds];
    weaponUnshieldedHit = [[NSDictionary alloc] initWithDictionary:unshieldedHitSounds];
    weaponLaunched = [[NSDictionary alloc] initWithDictionary:weaponLaunchedSounds];
}

setWeaponMount:toWeapon:

- (BOOL) setWeaponMount:		(OOWeaponFacing)	chosen_weapon_facing
toWeapon:		(NSString *)	eqKey

Reimplemented from ShipEntity.

Definition at line 9242 of file PlayerEntity.m.

                       :(OOWeaponFacing)facing toWeapon:(NSString *)eqKey
{
    return [self setWeaponMount:facing toWeapon:eqKey inContext:@"purchase"];
}

setWeaponMount:toWeapon:inContext:

- (BOOL) setWeaponMount:		(OOWeaponFacing)	facing
toWeapon:		(NSString *)	eqKey
inContext:		(NSString *)	context

Definition at line 9242 of file PlayerEntity.m.

                       :(OOWeaponFacing)facing toWeapon:(NSString *)eqKey inContext:(NSString *) context
{
 
    NSDictionary        *shipyardInfo = [[OOShipRegistry sharedRegistry] shipyardInfoForKey:[self shipDataKey]];
    unsigned            available_facings = [shipyardInfo oo_unsignedIntForKey:KEY_WEAPON_FACINGS defaultValue:[self weaponFacings]];   // use defaults  explicitly
    
    // facing exists?
    if (!(available_facings & facing)) 
    {
        return NO;
    }
    
    // weapon allowed (or NONE)?
    if (![eqKey isEqualToString:@"EQ_WEAPON_NONE"]) 
    {
        if (![self canAddEquipment:eqKey inContext:context]) 
        {
            return NO;
        }
    }
    
    // sets WEAPON_NONE if not recognised
    OOWeaponType chosen_weapon = OOWeaponTypeFromEquipmentIdentifierStrict(eqKey);
    
    switch (facing)
    {
        case WEAPON_FACING_FORWARD:
            forward_weapon_type = chosen_weapon;
            break;
            
        case WEAPON_FACING_AFT:
            aft_weapon_type = chosen_weapon;
            break;
            
        case WEAPON_FACING_PORT:
            port_weapon_type = chosen_weapon;
            break;
            
        case WEAPON_FACING_STARBOARD:
            starboard_weapon_type = chosen_weapon;
            break;
            
        case WEAPON_FACING_NONE:
            break;
    }
    
    return YES;
}

Referenced by PlayerShipSetProperty(), and ShipSetProperty().

Here is the caller graph for this function:

setWeaponsOnline:

- (void) setWeaponsOnline:

(BOOL)

newValue

Definition at line 13727 of file PlayerEntity.m.

                         :(BOOL)newValue
{
    weapons_online = !!newValue;
    if (!weapons_online)  [self safeAllMissiles];
}

setWitchspaceCountdown:

- (void) setWitchspaceCountdown:

(int)

spin_time

Definition at line 9242 of file PlayerEntity.m.

                               :(int)spin_time
{
    witchspaceCountdown = spin_time;
}

Referenced by PlayerShipBeginGalacticHyperspaceCountdown().

Here is the caller graph for this function:

setWormhole:

- (void) setWormhole:

(WormholeEntity *)

newWormhole

Definition at line 13727 of file PlayerEntity.m.

                    :(WormholeEntity*)newWormhole
{
    [wormhole release];
    if (newWormhole != nil)
    {
        wormhole = [newWormhole retain];
    }
    else
    {
        wormhole = nil;
    }
}

sharedPlayer

+ (PlayerEntity *) sharedPlayer

Definition at line 13727 of file PlayerEntity.m.

{
    if (EXPECT_NOT(gOOPlayer == nil))
    {
        gOOPlayer = [[PlayerEntity alloc] init];
    }
    return gOOPlayer;
}

Referenced by InitOOJSPlayerShip().

Here is the caller graph for this function:

shipCommodityData

- (OOCommodityMarket *) shipCommodityData

shipsFound_number

- (NSNumber *) shipsFound_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:shipsFound];
}

shipyardRecord

- (NSMutableDictionary *) shipyardRecord

Definition at line 9242 of file PlayerEntity.m.

{
    return shipyard_record;
}

showCommanderShip:

- (void) showCommanderShip: (int)  cdrArrayIndex

implementation

Provided by category PlayerEntity(OOLoadSavePrivate).

Definition at line 1011 of file PlayerEntityLoadSave.m.

                          :(int)cdrArrayIndex
{
    GuiDisplayGen *gui=[UNIVERSE gui];
    [UNIVERSE removeDemoShips];
    NSDictionary *cdr=[cdrDetailArray objectAtIndex: cdrArrayIndex];
    
    [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];
    
    if ([cdr oo_boolForKey:@"isFolder"])
    {
        NSString *folderDesc=[NSString stringWithFormat: DESC(@"loadsavescreen-hold-@-and-press-return-to-open-folder-@"), @COMMAND_MODIFIER_KEY, [[cdr oo_stringForKey:@"saved_game_path"] lastPathComponent]];
        [gui setColor: [OOColor orangeColor] forRow: CDRDESCROW];
        [gui addLongText: folderDesc startingAtRow: CDRDESCROW align: GUI_ALIGN_LEFT];
        return;
    }
    
    if ([cdr oo_boolForKey:@"isParentFolder"])
    {
        NSString *folderDesc=[NSString stringWithFormat: DESC(@"loadsavescreen-hold-@-and-press-return-to-open-parent-folder-@"), @COMMAND_MODIFIER_KEY, [[cdr oo_stringForKey:@"saved_game_path"] lastPathComponent]];
        [gui setColor: [OOColor orangeColor] forRow: CDRDESCROW];
        [gui addLongText: folderDesc startingAtRow: CDRDESCROW align: GUI_ALIGN_LEFT];
        return;
    }
    [gui setColor:[gui colorFromSetting:nil defaultValue:nil] forRow: CDRDESCROW];
 
    if (![cdr oo_boolForKey:@"isSavedGame"])  return;   // don't show things that aren't saved games
    
    if ([self dockedStation] == nil)  [self setDockedAtMainStation];
    
    // Display the commander's ship.
    NSString            *shipDesc = [cdr oo_stringForKey:@"ship_desc"];
    NSString            *shipName = nil;
    NSDictionary        *shipDict = nil;
    NSString            *rating = nil;
    uint16_t            personality = PersonalityForCommanderDict(cdr);
    
    shipDict = [[OOShipRegistry sharedRegistry] shipInfoForKey:shipDesc];
    if(shipDict != nil)
    {
        NSMutableDictionary * dict = [[NSMutableDictionary alloc] initWithCapacity:[shipDict count] + 1];
        [dict setDictionary:shipDict];
        id subEntStatus = [cdr objectForKey:@"subentities_status"];
        // don't add it to the dictionary if there's no subentities_status key
        if (subEntStatus != nil) [dict setObject:subEntStatus forKey:@"subentities_status"];
        [self showShipyardModel:shipDesc shipData:dict personality:personality];
        [dict release];
        shipName = [shipDict oo_stringForKey:@"display_name"];
        if (shipName == nil) shipName = [shipDict oo_stringForKey:KEY_NAME];
    }
    else
    {
        [self showShipyardModel:@"oolite-unknown-ship" shipData:nil personality:personality];
        shipName = [cdr oo_stringForKey:@"ship_name" defaultValue:@"unknown"];
        if (![[UNIVERSE useAddOns] isEqualToString:SCENARIO_OXP_DEFINITION_ALL])
        {
            shipName = [shipName stringByAppendingString:@" - OXPs disabled or not installed"];
        }
        else
        {
            shipName = [shipName stringByAppendingString:@" - OXP not installed"];
        }
    }
    
    // Make a short description of the commander
    NSString *legalDesc = OODisplayStringFromLegalStatus([cdr oo_intForKey:@"legal_status"]);
    
    rating = KillCountToRatingAndKillString([cdr oo_unsignedIntForKey:@"ship_kills"]);
    OOCreditsQuantity money = OODeciCreditsFromObject([cdr objectForKey:@"credits"]);
    
    // Nikos - Add some more information in the load game screen (current location, galaxy number and timestamp).
    //-------------------------------------------------------------------------------------------------------------------------
    
    int         galNumber;
    NSString        *timeStamp  = nil;
    NSString        *locationName = [cdr oo_stringForKey:@"current_system_name"];
 
    // If there is no key containing the name of the current system in
    // the savefile, calculating what it should have been is going to
    // be tricky now that system generation isn't seed based - but
    // this implies a save game well over 5 years old.
    if (locationName == nil)
    {   
        // Leaving the location blank in this case is probably okay
        locationName = @"";
    }
    
    galNumber = [cdr oo_intForKey:@"galaxy_number"] + 1;    // Galaxy numbering starts at 0.
 
    NSString *locationGov = @"";
    NSString *locationEco = @"";
    NSString *locationTL = [cdr objectForKey:@"current_system_techlevel"] ? [NSString stringWithFormat:@"%u", [cdr oo_unsignedIntForKey:@"current_system_techlevel"] + 1] : nil;
    if (locationTL)
    {
        locationGov = [NSString stringWithFormat:@"%c", [cdr oo_unsignedCharForKey:@"current_system_government"]];
        locationEco = [NSString stringWithFormat:@" %c", (7 - [cdr oo_unsignedCharForKey:@"current_system_economy"]) + 16];
    }
    else  locationTL = @"";
    
    timeStamp = ClockToString([cdr oo_doubleForKey:@"ship_clock" defaultValue:PLAYER_SHIP_CLOCK_START], NO);
    
    //-------------------------------------------------------------------------------------------------------------------------
    
    NSString        *cdrDesc = nil;
    
    cdrDesc = [NSString stringWithFormat:DESC(@"loadsavescreen-commander-@-rated-@-has-@-legal-status-@-ship-@-location-@-g-@-eco-@-gov-@-tl-@-timestamp-@"),
        [cdr oo_stringForKey:@"player_name"],
        rating,
        OOCredits(money),
        legalDesc,
        shipName,
        locationName,
        galNumber,
        locationEco,
        locationGov,
        locationTL,
        timeStamp];
    
    //-------------------------------------------------------------------------------------------------------------------------
    
    [gui addLongText:cdrDesc startingAtRow:CDRDESCROW align:GUI_ALIGN_LEFT];
    
}

showDemoShips

- (BOOL) showDemoShips

showGameOver

- (void) showGameOver

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    [hud resetGuis:[NSDictionary dictionaryWithObject:[NSDictionary dictionary] forKey:@"message_gui"]];
    NSString *scoreMS = [NSString stringWithFormat:OOExpandKey(@"gameoverscreen-score-@"),
                            KillCountToRatingAndKillString(ship_kills)];
    
    [UNIVERSE displayMessage:OOExpandKey(@"gameoverscreen-game-over") forCount:kDeadResetTime];
    [UNIVERSE displayMessage:@"" forCount:kDeadResetTime];
    [UNIVERSE displayMessage:scoreMS forCount:kDeadResetTime];
    [UNIVERSE displayMessage:@"" forCount:kDeadResetTime];
    [UNIVERSE displayMessage:OOExpandKey(@"gameoverscreen-press-space") forCount:kDeadResetTime];
    [UNIVERSE displayMessage:@" " forCount:kDeadResetTime];
    [UNIVERSE displayMessage:@"" forCount:kDeadResetTime];
    [self resetShotTime];
}

showInfoFlag

- (BOOL) showInfoFlag

Definition at line 9242 of file PlayerEntity.m.

{
    return show_info_flag;
}

showInformationForSelectedInterface

- (void) showInformationForSelectedInterface

Definition at line 9242 of file PlayerEntity.m.

{
    GuiDisplayGen* gui = [UNIVERSE gui];
    NSString* interfaceKey = [gui selectedRowKey];
    
    int i;
    
    for (i = GUI_ROW_EQUIPMENT_DETAIL; i < GUI_MAX_ROWS; i++)
    {
        [gui setText:@"" forRow:i];
        [gui setColor:[gui colorFromSetting:kGuiInterfaceDescriptionColor defaultValue:[OOColor greenColor]] forRow:i];
    }
    
    if (interfaceKey && ![interfaceKey hasPrefix:@"More:"])
    {
        NSDictionary *interfaces = [[self dockedStation] localInterfaces];
        OOJSInterfaceDefinition *definition = [interfaces objectForKey:interfaceKey];
        if (definition)
        {
            [gui addLongText:[definition summary] startingAtRow:GUI_ROW_INTERFACES_DETAIL align:GUI_ALIGN_LEFT];
        }
    }
 
}

showInformationForSelectedUpgrade

- (void) showInformationForSelectedUpgrade

Definition at line 9242 of file PlayerEntity.m.

{
    [self showInformationForSelectedUpgradeWithFormatString:nil];
}

Referenced by activateSelectedInterface.

Here is the caller graph for this function:

showInformationForSelectedUpgradeWithFormatString:

- (void) showInformationForSelectedUpgradeWithFormatString:

(NSString *)

extraString

Definition at line 9242 of file PlayerEntity.m.

                                                          :(NSString *)formatString
{
    GuiDisplayGen* gui = [UNIVERSE gui];
    NSString* eqKey = [gui selectedRowKey];
    int i;
 
    OOColor *descColor = [gui colorFromSetting:kGuiEquipmentDescriptionColor defaultValue:[OOColor greenColor]];
    for (i = GUI_ROW_EQUIPMENT_DETAIL; i < GUI_MAX_ROWS; i++)
    {
        [gui setText:@"" forRow:i];
        [gui setColor:descColor forRow:i];
    }
    if (eqKey)
    {
        if (![eqKey hasPrefix:@"More:"])
        {
            NSString* desc = [[OOEquipmentType equipmentTypeWithIdentifier:eqKey] descriptiveText];
            NSString* eq_key_damaged = [NSString stringWithFormat:@"%@_DAMAGED", eqKey];
            int weight = [[OOEquipmentType equipmentTypeWithIdentifier:eqKey] requiredCargoSpace];
            if ([self hasEquipmentItem:eq_key_damaged])
            {
                desc = [NSString stringWithFormat:DESC(@"upgradeinfo-@-price-is-for-repairing"), desc];
            }
            else
            {
                if([eqKey hasSuffix:@"ENERGY_UNIT"] && ([self hasEquipmentItem:@"EQ_ENERGY_UNIT_DAMAGED"] || [self hasEquipmentItem:@"EQ_ENERGY_UNIT"] || [self hasEquipmentItem:@"EQ_NAVAL_ENERGY_UNIT_DAMAGED"]))
                    desc = [NSString stringWithFormat:DESC(@"@-will-replace-other-energy"), desc];
                if (weight > 0) desc = [NSString stringWithFormat:DESC(@"upgradeinfo-@-weight-d-of-equipment"), desc, weight];
            }
            if (formatString) desc = [NSString stringWithFormat:formatString, desc];
            [gui addLongText:desc startingAtRow:GUI_ROW_EQUIPMENT_DETAIL align:GUI_ALIGN_LEFT];
        }
    }
}

showMarketCashAndLoadLine

- (void) showMarketCashAndLoadLine

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 9242 of file PlayerEntity.m.

{
    GuiDisplayGen *gui = [UNIVERSE gui];
    OOCargoQuantity currentCargo = current_cargo;
    OOCargoQuantity cargoCapacity = [self maxAvailableCargoSpace];
    [gui setText:OOExpandKey(@"market-cash-and-load", credits, currentCargo, cargoCapacity) forRow:GUI_ROW_MARKET_CASH];
    [gui setColor:[gui colorFromSetting:kGuiMarketCashColor defaultValue:[OOColor yellowColor]] forRow:GUI_ROW_MARKET_CASH];
}

showMarketScreenDataLine:forGood:inMarket:holdQuantity:

- (void) showMarketScreenDataLine: (OOGUIRow)  row forGood: (OOCommodityType)  good inMarket: (OOCommodityMarket *)  localMarket holdQuantity: (OOCargoQuantity)  quantity

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 9242 of file PlayerEntity.m.

                                 :(OOGUIRow)row forGood:(OOCommodityType)good inMarket:(OOCommodityMarket *)localMarket holdQuantity:(OOCargoQuantity)quantity
{
    GuiDisplayGen       *gui = [UNIVERSE gui];
    NSString* desc = [NSString stringWithFormat:@" %@ ", [shipCommodityData nameForGood:good]];
    OOCargoQuantity available_units = [localMarket quantityForGood:good];
    OOCargoQuantity units_in_hold = quantity;
    OOCreditsQuantity pricePerUnit = [localMarket priceForGood:good];
    OOMassUnit unit = [shipCommodityData massUnitForGood:good];
            
    NSString *available = OOPadStringToEms(((available_units > 0) ? (NSString *)[NSString stringWithFormat:@"%d",available_units] : DESC(@"commodity-quantity-none")), 2.5);
 
    NSUInteger priceDecimal = pricePerUnit % 10;
    NSString *price = [NSString stringWithFormat:@" %@.%llu ",OOPadStringToEms([NSString stringWithFormat:@"%lu",(unsigned long)(pricePerUnit/10)],2.5),priceDecimal];
            
    // this works with up to 9999 tons of gemstones. Any more than that, they deserve the formatting they get! :)
            
    NSString *owned = OOPadStringToEms((units_in_hold > 0) ? (NSString *)[NSString stringWithFormat:@"%d",units_in_hold] : DESC(@"commodity-quantity-none"), 4.5);
    NSString *units = DisplayStringForMassUnit(unit);
    NSString *units_available = [NSString stringWithFormat:@" %@ %@ ",available, units];
    NSString *units_owned = [NSString stringWithFormat:@" %@ %@ ",owned, units];
 
    NSUInteger import_legality = [localMarket importLegalityForGood:good];
    NSUInteger export_legality = [localMarket exportLegalityForGood:good];
    NSString *legaldesc = nil;
    if (import_legality == 0)
    {
        if (export_legality == 0)
        {
            legaldesc = DESC(@"oolite-legality-clear");
        }
        else
        {
            legaldesc = DESC(@"oolite-legality-import");
        }
    } 
    else
    {
        if (export_legality == 0)
        {
            legaldesc = DESC(@"oolite-legality-export");
        }
        else
        {
            legaldesc = DESC(@"oolite-legality-neither");
        }
    }
    legaldesc = [NSString stringWithFormat:@" %@ ",legaldesc];
            
    NSString *extradesc = [shipCommodityData shortCommentForGood:good];
 
    [gui setKey:good forRow:row];
    [gui setColor:[gui colorFromSetting:kGuiMarketCommodityColor defaultValue:nil] forRow:row];
    [gui setArray:[NSArray arrayWithObjects: desc, extradesc, price, units_available, units_owned, legaldesc,  nil] forRow:row++];
 
}

showMarketScreenHeaders

- (void) showMarketScreenHeaders

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 9242 of file PlayerEntity.m.

{
    GuiDisplayGen       *gui = [UNIVERSE gui];
    OOGUITabSettings tab_stops;
    tab_stops[0] = 0;
    tab_stops[1] = 137; 
    tab_stops[2] = 187;
    tab_stops[3] = 267;
    tab_stops[4] = 321;
    tab_stops[5] = 431;
    [gui overrideTabs:tab_stops from:kGuiMarketTabs length:6];
    [gui setTabStops:tab_stops];
    
    [gui setColor:[gui colorFromSetting:kGuiMarketHeadingColor defaultValue:[OOColor greenColor]] forRow:GUI_ROW_MARKET_KEY];
    [gui setArray:[NSArray arrayWithObjects: DESC(@"commodity-column-title"), OOPadStringToEms(DESC(@"price-column-title"),3.5),
                           OOPadStringToEms(DESC(@"for-sale-column-title"),3.75), OOPadStringToEms(DESC(@"in-hold-column-title"),5.75), DESC(@"oolite-legality-column-title"), DESC(@"oolite-extras-column-title"), nil] forRow:GUI_ROW_MARKET_KEY];
    [gui setArray:[NSArray arrayWithObjects: DESC(@"commodity-column-title"), DESC(@"oolite-extras-column-title"), OOPadStringToEms(DESC(@"price-column-title"),3.5),
                           OOPadStringToEms(DESC(@"for-sale-column-title"),3.75), OOPadStringToEms(DESC(@"in-hold-column-title"),5.75), DESC(@"oolite-legality-column-title"), nil] forRow:GUI_ROW_MARKET_KEY];
 
}

showScenarioDetails

- (void) showScenarioDetails

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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];
            }
        }
 
    }
}

showShipModel:

- (void) showShipModel:

(NSString *)

shipKey

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                      :(NSString *)role
{
    if ([role isEqualToString:@"none"] || [role length] == 0)
    {
        [UNIVERSE removeDemoShips];
        return;
    }
    
    ShipEntity *ship = [UNIVERSE makeDemoShipWithRole:role spinning:YES];
    OOLog(kOOLogNoteShowShipModel, @"::::: showShipModel:'%@' (%@) (%@)", role, ship, [ship name]);
}

showShipModelWithKey:shipData:personality:factorX:factorY:factorZ:inContext:

- (void) showShipModelWithKey:		(NSString *)	shipKey
shipData:		(NSDictionary *)	shipData
personality:		(uint16_t)	personality
factorX:		(GLfloat)	factorX
factorY:		(GLfloat)	factorY
factorZ:		(GLfloat)	factorZ
inContext:		(NSString *)	context

Definition at line 13727 of file PlayerEntity.m.

                             :(NSString *)shipKey shipData:(NSDictionary *)shipData personality:(uint16_t)personality factorX:(GLfloat)factorX factorY:(GLfloat)factorY factorZ:(GLfloat)factorZ inContext:(NSString *)context
{
    if (shipKey == nil)  return;
    if (shipData == nil)  shipData = [[OOShipRegistry sharedRegistry] shipInfoForKey:shipKey];
    if (shipData == nil)  return;
    
    Quaternion      q2 = { (GLfloat)M_SQRT1_2, (GLfloat)M_SQRT1_2, (GLfloat)0.0f, (GLfloat)0.0f };
    // MKW - retrieve last demo ships' orientation and release it
    if( demoShip != nil )
    {
        q2 = [demoShip orientation];
        [demoShip release];
    }
    
    ShipEntity *ship = [[ProxyPlayerEntity alloc] initWithKey:shipKey definition:shipData];
    if (personality != ENTITY_PERSONALITY_INVALID)  [ship setEntityPersonalityInt:personality];
    
    [ship wasAddedToUniverse];
    
    if (context)  OOLog(@"script.debug.note.showShipModel", @"::::: showShipModel:'%@' in context: %@.", [ship name], context);
    
    GLfloat cr = [ship collisionRadius];
    [ship setOrientation: q2];
    [ship setPositionX:factorX * cr y:factorY * cr z:factorZ * cr];
    [ship setScanClass: CLASS_NO_DRAW];
    [ship setDemoShip: 0.6];
    [ship setDemoStartTime: [UNIVERSE getTime]];
    if([ship pendingEscortCount] > 0) [ship setPendingEscortCount:0];
    [ship setAITo: @"nullAI.plist"];
    id subEntStatus = [shipData objectForKey:@"subentities_status"];
    // show missing subentities if there's a subentities_status key
    if (subEntStatus != nil) [ship deserializeShipSubEntitiesFrom:(NSString *)subEntStatus];
    [UNIVERSE addEntity: ship];
    // MKW - save demo ship for its rotation
    demoShip = [ship retain];
    
    [ship setStatus: STATUS_COCKPIT_DISPLAY];
    
    [ship release];
}

showShipyardInfoForSelection

- (void) showShipyardInfoForSelection

Provided by category PlayerEntity(Contracts).

Definition at line 1443 of file PlayerEntityContracts.m.

{
    NSUInteger      i;
    GuiDisplayGen   *gui = [UNIVERSE gui];
    OOGUIRow        sel_row = [gui selectedRow];
    
    if (sel_row <= 0)  return;
    
    NSMutableArray *row_info = [NSMutableArray arrayWithArray:(NSArray*)[gui objectForRow:GUI_ROW_SHIPYARD_LABELS]];
    while ([row_info count] < 4)
    {
        [row_info addObject:@""];
    }
    
    NSString *key = [gui keyForRow:sel_row];
    
    NSDictionary *info = [currentShipyard oo_dictionaryForKey:key];
 
    // clean up the display ready for the newly-selected ship (if there is one)
    [row_info replaceObjectAtIndex:2 withObject:@""];
    [row_info replaceObjectAtIndex:3 withObject:@""];
    for (i = GUI_ROW_SHIPYARD_INFO_START; i < GUI_ROW_MARKET_CASH - 1; i++)
    {
        [gui setText:@"" forRow:i];
        [gui setColor:[gui colorFromSetting:kGuiShipyardDescriptionColor defaultValue:[OOColor greenColor]] forRow:i];
    }
    [UNIVERSE removeDemoShips];
 
    if (info)
    {
        // the key is a particular ship - show the details
        NSString *salesPitch = [info oo_stringForKey:KEY_SHORT_DESCRIPTION];
        NSDictionary *shipDict = [info oo_dictionaryForKey:SHIPYARD_KEY_SHIP];
        
        int cargoRating = [shipDict oo_intForKey:@"max_cargo"];
        int cargo_extra;
        cargo_extra = [shipDict oo_intForKey:@"extra_cargo" defaultValue:15];
        float speedRating = 0.001 * [shipDict oo_intForKey:@"max_flight_speed"];
        
        NSArray *shipExtras = [info oo_arrayForKey:KEY_EQUIPMENT_EXTRAS];
        for (i = 0; i < [shipExtras count]; i++)
        {
            if ([[shipExtras oo_stringAtIndex:i] isEqualToString:@"EQ_CARGO_BAY"])
            {
                cargoRating += cargo_extra;
            }
            else if ([[shipExtras oo_stringAtIndex:i] isEqualToString:@"EQ_PASSENGER_BERTH"])
            {
                cargoRating -= PASSENGER_BERTH_SPACE;
            }
        }
        
        [row_info replaceObjectAtIndex:2 withObject:OOExpandKey(@"shipyard-cargo-value", cargoRating)];
        [row_info replaceObjectAtIndex:3 withObject:OOExpandKey(@"shipyard-speed-value", speedRating)];
        
        // Show footer first. It'll be overwritten by the sales_pitch if that text is longer than usual.
        [self showTradeInInformationFooter];
        i = [gui addLongText:salesPitch startingAtRow:GUI_ROW_SHIPYARD_INFO_START align:GUI_ALIGN_LEFT];
        if (i - 1 >= GUI_ROW_MARKET_CASH - 1)
        {
            [gui setColor:[gui colorFromSetting:kGuiShipyardDescriptionColor defaultValue:[OOColor greenColor]] forRow:i - 1];
            [gui setColor:[gui colorFromSetting:kGuiShipyardDescriptionColor defaultValue:[OOColor greenColor]] forRow:GUI_ROW_MARKET_CASH - 1];
        }
        
        // now display the ship
        [self showShipyardModel:[info oo_stringForKey:SHIPYARD_KEY_SHIPDATA_KEY]
                       shipData:shipDict
                    personality:[info oo_unsignedShortForKey:SHIPYARD_KEY_PERSONALITY]];
    }
    else
    {
        // the key is a particular model of ship which we must expand...
        // build an array from the entries for that model in the currentShipyard TODO
        // 
    }
 
    [gui setArray:[NSArray arrayWithArray:row_info] forRow:GUI_ROW_SHIPYARD_LABELS];
}

showShipyardModel:shipData:personality:

- (void) showShipyardModel:		(NSString *)	shipKey
shipData:		(NSDictionary *)	shipDict
personality:		(uint16_t)	personality

Provided by category PlayerEntity(Contracts).

Definition at line 1443 of file PlayerEntityContracts.m.

                          :(NSString *)shipKey shipData:(NSDictionary *)shipData personality:(uint16_t)personality
{
    if (shipKey == nil || [self dockedStation] == nil)  return;
    [self showShipModelWithKey:shipKey shipData:shipData personality:personality factorX:1.2 factorY:0.8 factorZ:6.4 inContext:@"shipyard"];
}

showTradeInInformationFooter

- (void) showTradeInInformationFooter

Provided by category PlayerEntity(Contracts).

Definition at line 1443 of file PlayerEntityContracts.m.

{
    GuiDisplayGen *gui = [UNIVERSE gui];
    OOCreditsQuantity tradeIn = [self tradeInValue];
    OOCreditsQuantity total = tradeIn + credits;
    NSString *shipType = [self displayName];
    
    [gui setColor:[gui colorFromSetting:kGuiShipyardTradeinColor defaultValue:nil] forRow:GUI_ROW_MARKET_CASH - 1];
    [gui setColor:[gui colorFromSetting:kGuiShipyardTradeinColor defaultValue:nil] forRow:GUI_ROW_MARKET_CASH];
    [gui setText:OOExpandKey(@"shipyard-trade-in-value", shipType, tradeIn) forRow: GUI_ROW_MARKET_CASH - 1];
    [gui setText:OOExpandKey(@"shipyard-total-available-with-trade-in", shipType, total, credits, tradeIn) forRow: GUI_ROW_MARKET_CASH];
}

SliderString

+ (static NSString *) SliderString (NSInteger)  amountIn20ths

implementation

Definition at line 8865 of file PlayerEntity.m.

{
    NSString *filledSlider = [@"|||||||||||||||||||||||||" substringToIndex:amountIn20ths];
    NSString *emptySlider =  [@"........................." substringToIndex:20 - amountIn20ths];
    return [NSString stringWithFormat:@"%@%@", filledSlider, emptySlider];
}

sortCommanders

- (NSComparisonResult) sortCommanders (id)  cdr1 (id)  cdr2 (void *)  context

implementation

Provided by category PlayerEntity(OOLoadSavePrivate).

Definition at line 1011 of file PlayerEntityLoadSave.m.

{
    return [[cdr1 objectForKey:@"saved_game_path"] localizedCompare:[cdr2 objectForKey:@"saved_game_path"]];
}

spawnShip:

- (void) spawnShip:

(NSString *)

ship_key

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *)ship_key
{
    if ([UNIVERSE spawnShip:ship_key])
    {
        OOLog(kOOLogNoteAddShips, @"DEBUG: Spawned ship with shipdata key '%@'.", ship_key);
    }
    else
    {
        OOLog(kOOLogScriptAddShipsFailed, @"***** SCRIPT ERROR: in %@, could not spawn ship with shipdata key '%@'.", CurrentScriptDesc(), ship_key);
    }
}

specialCargo

- (NSString *) specialCargo

startAfterburnerSound

- (void) startAfterburnerSound

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    if (!afterburnerSoundLooping)
    {
        afterburnerSoundLooping = YES;
        [self updateAfterburnerSound];
    }
}

startScenario

- (BOOL) startScenario

Provided by category PlayerEntity(LoadSave).

Definition at line 1420 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;
}

startUpComplete

- (void) startUpComplete

Definition at line 13727 of file PlayerEntity.m.

{
    JSContext *context = OOJSAcquireContext();
    [self doWorldScriptEvent:OOJSID("startUpComplete") inContext:context withArguments:NULL count:0 timeLimit:kOOJSLongTimeLimit];
    OOJSRelinquishContext(context);
}

status_string

- (NSString *) status_string

Provided by category PlayerEntity(Scripting).

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

{
    return OOStringFromEntityStatus([self status]);
}

stickFunctionList

- (NSArray *) stickFunctionList

implementation

Provided by category PlayerEntity(StickMapperInternal).

Definition at line 1 of file PlayerEntityStickMapper.m.

{
    NSMutableArray *funcList = [NSMutableArray array];
 
    // propulsion   
    [funcList addObject:[self makeStickGuiDictHeader:DESC(@"stickmapper-header-propulsion")]];
    [funcList addObject: 
     [self makeStickGuiDict:DESC(@"stickmapper-roll")
                  allowable:HW_AXIS
                     axisfn:AXIS_ROLL
                      butfn:STICK_NOFUNCTION]];
    [funcList addObject: 
     [self makeStickGuiDict:DESC(@"stickmapper-pitch")
                  allowable:HW_AXIS
                     axisfn:AXIS_PITCH
                      butfn:STICK_NOFUNCTION]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-yaw")
                  allowable:HW_AXIS
                     axisfn:AXIS_YAW
                      butfn:STICK_NOFUNCTION]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-increase-thrust")
                  allowable:HW_AXIS|HW_BUTTON
                     axisfn:AXIS_THRUST
                      butfn:BUTTON_INCTHRUST]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-decrease-thrust")
                  allowable:HW_AXIS|HW_BUTTON
                     axisfn:AXIS_THRUST
                      butfn:BUTTON_DECTHRUST]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-fuel-injection")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_FUELINJECT]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-hyperspeed")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_HYPERSPEED]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-hyperdrive")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_HYPERDRIVE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-gal-hyperdrive")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_GALACTICDRIVE]];
 
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-roll/pitch-precision-toggle")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_PRECISION]];
 
    // navigation
    [funcList addObject:[self makeStickGuiDictHeader:DESC(@"stickmapper-header-navigation")]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-compass-mode-next")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_COMPASSMODE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-compass-mode-prev")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_COMPASSMODE_PREV]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-scanner-zoom")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_SCANNERZOOM]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-scanner-unzoom")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_SCANNERUNZOOM]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-view-forward")
                  allowable:HW_AXIS|HW_BUTTON
                     axisfn:AXIS_VIEWY
                      butfn:BUTTON_VIEWFORWARD]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-view-aft")
                  allowable:HW_AXIS|HW_BUTTON
                     axisfn:AXIS_VIEWY
                      butfn:BUTTON_VIEWAFT]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-view-port")
                  allowable:HW_AXIS|HW_BUTTON
                     axisfn:AXIS_VIEWX
                      butfn:BUTTON_VIEWPORT]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-view-starboard")
                  allowable:HW_AXIS|HW_BUTTON
                     axisfn:AXIS_VIEWX
                      butfn:BUTTON_VIEWSTARBOARD]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-ext-view-cycle")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_EXTVIEWCYCLE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-toggle-ID")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_ID]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-docking-clearance")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_DOCKINGCLEARANCE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-dockcpu")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_DOCKCPU]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-dockcpufast")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_DOCKCPUFAST]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-docking-music")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_DOCKINGMUSIC]];
 
    // offensive
    [funcList addObject:[self makeStickGuiDictHeader:DESC(@"stickmapper-header-offensive")]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-weapons-online-toggle")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_WEAPONSONLINETOGGLE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-primary-weapon")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_FIRE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-secondary-weapon")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_LAUNCHMISSILE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-arm-secondary")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_ARMMISSILE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-disarm-secondary")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_UNARM]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-target-nearest-incoming-missile")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_TARGETINCOMINGMISSILE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-cycle-secondary")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_CYCLEMISSILE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-next-target")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_NEXTTARGET]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-previous-target")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_PREVTARGET]];
 
    // defensive
    [funcList addObject:[self makeStickGuiDictHeader:DESC(@"stickmapper-header-defensive")]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-ECM")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_ECM]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-jettison")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_JETTISON]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-rotate-cargo")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_ROTATECARGO]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-escape-pod")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_ESCAPE]];
 
    // oxp special equip
    [funcList addObject:[self makeStickGuiDictHeader:DESC(@"stickmapper-header-special-equip")]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-mfd-select-next")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_MFDSELECTNEXT]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-mfd-select-prev")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_MFDSELECTPREV]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-mfd-cycle-next")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_MFDCYCLENEXT]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-mfd-cycle-prev")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_MFDCYCLEPREV]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-prime-equipment")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_PRIMEEQUIPMENT]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-prime-prev-equipment")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_PRIMEEQUIPMENT]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-activate-equipment")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_ACTIVATEEQUIPMENT]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-mode-equipment")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_MODEEQUIPMENT]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-fastactivate-a")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_CLOAK]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-fastactivate-b")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_ENERGYBOMB]];
 
    // misc
    [funcList addObject:[self makeStickGuiDictHeader:DESC(@"stickmapper-header-misc")]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-snapshot")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_SNAPSHOT]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-pause")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_PAUSE]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-toggle-hud")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_TOGGLEHUD]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-comms-log")
                  allowable:HW_BUTTON
                     axisfn:STICK_NOFUNCTION
                      butfn:BUTTON_COMMSLOG]];
#if OO_FOV_INFLIGHT_CONTROL_ENABLED
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-increase-field-of-view")
                  allowable:HW_AXIS|HW_BUTTON
                     axisfn:AXIS_FIELD_OF_VIEW
                      butfn:BUTTON_INC_FIELD_OF_VIEW]];
    [funcList addObject:
     [self makeStickGuiDict:DESC(@"stickmapper-decrease-field-of-view")
                  allowable:HW_AXIS|HW_BUTTON
                     axisfn:AXIS_FIELD_OF_VIEW
                      butfn:BUTTON_DEC_FIELD_OF_VIEW]];
#endif
    if ([customEquipActivation count] > 0) {
        [funcList addObject:[self makeStickGuiDictHeader:DESC(@"stickmapper-header-oxp-equip")]];
        int i;
        for (i = 0; i < [customEquipActivation count]; i++)
        {
            [funcList addObject:
            [self makeStickGuiDict:[NSString stringWithFormat: @"Activate '%@'", [[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPNAME]]
                        allowable:HW_BUTTON
                            axisfn:STICK_NOFUNCTION
                            butfn:(i+10000)]];
            [funcList addObject:
            [self makeStickGuiDict:[NSString stringWithFormat: @"Mode '%@'", [[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPNAME]]
                        allowable:HW_BUTTON
                            axisfn:STICK_NOFUNCTION
                            butfn:(i+20000)]];
        }
 
    }
    return funcList;
}

stickMapperInputHandler:view:

- (void) stickMapperInputHandler:		(GuiDisplayGen *)	gui
view:		(MyOpenGLView *)	gameView

Provided by category PlayerEntity(StickMapper).

Definition at line 1 of file PlayerEntityStickMapper.m.

                                :(GuiDisplayGen *)gui
                            view:(MyOpenGLView *)gameView
{
    OOJoystickManager   *stickHandler = [OOJoystickManager sharedStickHandler];
 
    // Don't do anything if the user is supposed to be selecting
    // a function - other than look for Escape.
    if(waitingForStickCallback)
    {
        if([gameView isDown: 27])
        {
            [stickHandler clearCallback];
            [gui setArray: [NSArray arrayWithObjects:
                            @"Function setting aborted.", nil]
                   forRow: GUI_ROW_INSTRUCT];
            waitingForStickCallback=NO;
        }
 
        // Break out now.
        return;
    }
    
    [self handleGUIUpDownArrowKeys];
    
    if ([gui selectedRow] == GUI_ROW_STICKPROFILE && [gameView isDown: 13])
    {
        [self setGuiToStickProfileScreen: gui];
        return;
    }
    
    NSString* key = [gui keyForRow: [gui selectedRow]];
    if ([key hasPrefix:@"Index:"])
        selFunctionIdx=[[[key componentsSeparatedByString:@":"] objectAtIndex: 1] intValue];
    else
        selFunctionIdx=-1;
 
    if([gameView isDown: 13])
    {
        if ([key hasPrefix:@"More:"])
        {
            int from_function = [[[key componentsSeparatedByString:@":"] objectAtIndex: 1] intValue];
            if (from_function < 0)  from_function = 0;
            
            [self setGuiToStickMapperScreen:from_function];
            if ([[UNIVERSE gui] selectedRow] < 0)
                [[UNIVERSE gui] setSelectedRow: GUI_ROW_FUNCSTART];
            if (from_function == 0)
                [[UNIVERSE gui] setSelectedRow: GUI_ROW_FUNCSTART + MAX_ROWS_FUNCTIONS - 1];
            return;
        }
        
        NSDictionary *entry=[stickFunctions objectAtIndex: selFunctionIdx];
        int hw=[(NSNumber *)[entry objectForKey: KEY_ALLOWABLE] intValue];
        [stickHandler setCallback: @selector(updateFunction:)
                           object: self 
                         hardware: hw];
        
        // Print instructions
        NSString *instructions;
        switch(hw)
        {
            case HW_AXIS:
                instructions = @"Fully deflect the axis you want to use for this function. Esc aborts.";
                break;
            case HW_BUTTON:
                instructions = @"Press the button you want to use for this function. Esc aborts.";
                break;
            default:
                instructions = @"Press the button or deflect the axis you want to use for this function.";
        }
        [gui setArray: [NSArray arrayWithObjects: instructions, nil] forRow: GUI_ROW_INSTRUCT];
        waitingForStickCallback=YES;
    }
    
    if([gameView isDown: 'u'])
    {
        if (selFunctionIdx >= 0)  [self removeFunction: selFunctionIdx];
    }
}

stickProfileGraphAxisProfile:screenAt:screenSize:

- (void) stickProfileGraphAxisProfile:		(GLfloat)	alpha
screenAt:		(Vector)	screenAt
screenSize:		(NSSize)	screenSize

Provided by category PlayerEntity(StickProfile).

Definition at line 43 of file PlayerEntityStickProfile.m.

                                     : (GLfloat) alpha screenAt: (Vector) screenAt screenSize: (NSSize) screenSize
{
 
    [stickProfileScreen graphProfile: alpha at: make_vector(screenAt.x - 110.0, screenAt.y - 100, screenAt.z) size: NSMakeSize(220,220)];
    return;
}

stickProfileInputHandler:view:

- (void) stickProfileInputHandler:		(GuiDisplayGen *)	gui
view:		(MyOpenGLView *)	gameView

Provided by category PlayerEntity(StickProfile).

Definition at line 43 of file PlayerEntityStickProfile.m.

                                 : (GuiDisplayGen *) gui
    view: (MyOpenGLView *) gameView
{
    if ([gameView isDown: gvMouseLeftButton])
    {
        NSPoint mouse_position = NSMakePoint(
            [gameView virtualJoystickPosition].x * [gui size].width,
            [gameView virtualJoystickPosition].y * [gui size].height );
        [stickProfileScreen mouseDown: mouse_position];
    }
    else
    {
        [stickProfileScreen mouseUp];
    }
    if ([gameView isDown: gvDeleteKey])
    {
        [stickProfileScreen deleteSelected];
    }
    [self handleGUIUpDownArrowKeys];
    
    if ([self checkKeyPress:n_key_gui_select] && [gui selectedRow] == GUI_ROW_STICKPROFILE_BACK)
    {
        [stickProfileScreen saveSettings];
        [self setGuiToStickMapperScreen: 0 resetCurrentRow: YES];
    }
    switch ([gui selectedRow])
    {
    case GUI_ROW_STICKPROFILE_AXIS:
        if ([self checkKeyPress:n_key_gui_arrow_left])
        {
            if (!stickProfileArrow_pressed && ![self checkKeyPress:n_key_gui_arrow_right])
            {
                [stickProfileScreen previousAxis];
                stickProfileArrow_pressed = YES;
            }
        }
        else if ([self checkKeyPress: n_key_gui_arrow_right])
        {
            if (!stickProfileArrow_pressed && ![self checkKeyPress: n_key_gui_arrow_left])
            {
                [stickProfileScreen nextAxis];
                stickProfileArrow_pressed = YES;
            }
        }
        else
        {
            stickProfileArrow_pressed = NO;
        }
        break;
 
    case GUI_ROW_STICKPROFILE_DEADZONE:
        if ([self checkKeyPress:n_key_gui_arrow_left])
        {
            if (!stickProfileArrow_pressed && ![self checkKeyPress: n_key_gui_arrow_right])
            {
                [stickProfileScreen decreaseDeadzone];
                stickProfileArrow_pressed = YES;
            }
        }
        else if ([self checkKeyPress: n_key_gui_arrow_right])
        {
            if (!stickProfileArrow_pressed && ![self checkKeyPress: n_key_gui_arrow_left])
            {
                [stickProfileScreen increaseDeadzone];
                stickProfileArrow_pressed = YES;
            }
        }
        else
        {
            stickProfileArrow_pressed = NO;
        }
        break;
 
    case GUI_ROW_STICKPROFILE_PROFILE_TYPE:
        if ([self checkKeyPress:n_key_gui_arrow_left])
        {
            if (!stickProfileArrow_pressed && ![self checkKeyPress: n_key_gui_arrow_right])
            {
                [stickProfileScreen previousProfileType];
                stickProfileArrow_pressed = YES;
            }
        }
        else if ([self checkKeyPress: n_key_gui_arrow_right])
        {
            if (!stickProfileArrow_pressed && ![self checkKeyPress: n_key_gui_arrow_left])
            {
                [stickProfileScreen nextProfileType];
                stickProfileArrow_pressed = YES;
            }
        }
        else
        {
            stickProfileArrow_pressed = NO;
        }
        break;
    }
        
    if (![stickProfileScreen currentProfileIsSpline])
    {
        if ([gui selectedRow] == GUI_ROW_STICKPROFILE_POWER)
        {
            if ([self checkKeyPress:n_key_gui_arrow_left])
            {
                if (!stickProfileArrow_pressed && ![self checkKeyPress: n_key_gui_arrow_right])
                {
                    [stickProfileScreen DecreasePower];
                    stickProfileArrow_pressed = YES;
                }
            }
            else if ([self checkKeyPress: n_key_gui_arrow_right])
            {
                if (!stickProfileArrow_pressed && ![self checkKeyPress: n_key_gui_arrow_left])
                {
                    [stickProfileScreen IncreasePower];
                    stickProfileArrow_pressed = YES;
                }
            }
            else
            {
                stickProfileArrow_pressed = NO;
            }
        }
        else if ([gui selectedRow] == GUI_ROW_STICKPROFILE_PARAM)
        {
            if ([self checkKeyPress:n_key_gui_arrow_left])
            {
                if (!stickProfileArrow_pressed && ![self checkKeyPress: n_key_gui_arrow_right])
                {
                    [stickProfileScreen DecreaseParam];
                    stickProfileArrow_pressed = YES;
                }
            }
            else if ([self checkKeyPress: n_key_gui_arrow_right])
            {
                if (!stickProfileArrow_pressed && ![self checkKeyPress: n_key_gui_arrow_left])
                {
                    [stickProfileScreen IncreaseParam];
                    stickProfileArrow_pressed = YES;
                }
            }
            else
            {
                stickProfileArrow_pressed = NO;
            }
        }
    }
    return;
}

stopAfterburnerSound

- (void) stopAfterburnerSound

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    // Do nothing, stop is detected in updateAfterburnerSound
}

subtract:

- (void) subtract:

(NSString *)

missionVariableString_value

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                 :(NSString *)missionVariableString_value
{
    NSString*   missionVariableString = nil;
    NSString*   valueString;
    double  value;
    NSMutableArray* tokens = ScanTokensFromString(missionVariableString_value);
    BOOL hasMissionPrefix, hasLocalPrefix;
 
    if ([tokens count] < 2)
    {
        OOLog(kOOLogSyntaxSubtract, @"***** SCRIPT ERROR: in %@, CANNOT SUBTRACT: '%@'", CurrentScriptDesc(), missionVariableString_value);
        return;
    }
 
    missionVariableString = [tokens objectAtIndex:0];
    [tokens removeObjectAtIndex:0];
    valueString = [tokens componentsJoinedByString:@" "];
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
    
    if (hasMissionPrefix)
    {
        value = [[self missionVariableForKey:missionVariableString] doubleValue];
        value -= [valueString doubleValue];
        [self setMissionVariable:[NSString stringWithFormat:@"%f", value] forKey:missionVariableString];
    }
    else if (hasLocalPrefix)
    {
        value = [[self localVariableForKey:missionVariableString andMission:sCurrentMissionKey] doubleValue];
        value -= [valueString doubleValue];
        [self setLocalVariable:[NSString stringWithFormat:@"%f", value] forKey:missionVariableString andMission:sCurrentMissionKey];
    }
    else
    {
        OOLog(kOOLogSyntaxSubtract, @"***** SCRIPT ERROR: in %@, CANNOT SUBTRACT: '%@' -- IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString_value, missionVariableString_value);
    }
}

sunGoneNova_bool

- (NSString *) sunGoneNova_bool

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return ([[UNIVERSE sun] goneNova])? @"YES" : @"NO";
}

sunWillGoNova_bool

- (NSString *) sunWillGoNova_bool

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    return ([[UNIVERSE sun] willGoNova])? @"YES" : @"NO";
}

suppressClangStuff

- (BOOL) suppressClangStuff

implementation

Definition at line 9242 of file PlayerEntity.m.

{
    return missionChoice &&
    commanderNameString &&
    cdrDetailArray &&
    currentPage &&
    n_key_roll_left &&
    n_key_roll_right &&
    n_key_pitch_forward &&
    n_key_pitch_back &&
    n_key_yaw_left &&
    n_key_yaw_right &&
    n_key_view_forward &&
    n_key_view_aft &&
    n_key_view_port &&
    n_key_view_starboard &&
    n_key_launch_ship &&
    n_key_gui_screen_options &&
    n_key_gui_screen_equipship &&
    n_key_gui_screen_interfaces &&
    n_key_gui_screen_status &&
    n_key_gui_chart_screens &&
    n_key_gui_system_data &&
    n_key_gui_market &&
    n_key_gui_arrow_left &&
    n_key_gui_arrow_right &&
    n_key_gui_arrow_up &&
    n_key_gui_arrow_down &&
    n_key_gui_page_up &&
    n_key_gui_page_down &&
    n_key_gui_select &&
    n_key_increase_speed &&
    n_key_decrease_speed &&
    n_key_inject_fuel &&
    n_key_fire_lasers &&
    n_key_launch_missile &&
    n_key_next_missile &&
    n_key_ecm &&
    n_key_prime_next_equipment &&
    n_key_prime_previous_equipment &&
    n_key_activate_equipment &&
    n_key_mode_equipment &&
    n_key_fastactivate_equipment_a &&
    n_key_fastactivate_equipment_b &&
    n_key_target_missile &&
    n_key_untarget_missile &&
    n_key_target_incoming_missile &&
    n_key_ident_system &&
    n_key_scanner_zoom &&
    n_key_scanner_unzoom &&
    n_key_launch_escapepod &&
    n_key_galactic_hyperspace &&
    n_key_hyperspace &&
    n_key_jumpdrive &&
    n_key_dump_cargo &&
    n_key_rotate_cargo &&
    n_key_autopilot &&
    n_key_autodock &&
    n_key_snapshot &&
    n_key_docking_music &&
    n_key_advanced_nav_array_next &&
    n_key_advanced_nav_array_previous &&
    n_key_info_next_system &&
    n_key_info_previous_system &&
    n_key_map_home &&
    n_key_map_end &&
    n_key_map_next_system &&
    n_key_map_previous_system &&
    n_key_map_info &&
    n_key_map_zoom_in &&
    n_key_map_zoom_out &&
    n_key_system_home &&
    n_key_system_end &&
    n_key_system_next_system &&
    n_key_system_previous_system &&
    n_key_pausebutton &&
    n_key_show_fps &&
    n_key_bloom_toggle &&
    n_key_mouse_control_roll &&
    n_key_mouse_control_yaw &&
    n_key_hud_toggle &&
    n_key_comms_log &&
    n_key_prev_compass_mode &&
    n_key_next_compass_mode &&
    n_key_chart_highlight &&
    n_key_market_filter_cycle &&
    n_key_market_sorter_cycle &&
    n_key_market_buy_one &&
    n_key_market_sell_one &&
    n_key_market_buy_max &&
    n_key_market_sell_max &&
    n_key_next_target &&
    n_key_previous_target &&
    n_key_custom_view &&
    n_key_custom_view_zoom_out &&
    n_key_custom_view_zoom_in &&
    n_key_custom_view_roll_left &&
    n_key_custom_view_pan_left &&
    n_key_custom_view_roll_right &&
    n_key_custom_view_pan_right &&
    n_key_custom_view_rotate_up &&
    n_key_custom_view_pan_up &&
    n_key_custom_view_rotate_down &&
    n_key_custom_view_pan_down &&
    n_key_custom_view_rotate_left &&
    n_key_custom_view_rotate_right &&
    n_key_docking_clearance_request &&
    n_key_weapons_online_toggle &&
    n_key_cycle_next_mfd &&
    n_key_cycle_previous_mfd &&
    n_key_switch_next_mfd &&
    n_key_switch_previous_mfd &&
    n_key_oxzmanager_setfilter &&
    n_key_oxzmanager_showinfo &&
    n_key_oxzmanager_extract &&
#if OO_FOV_INFLIGHT_CONTROL_ENABLED
    n_key_inc_field_of_view &&
    n_key_dec_field_of_view &&
#endif
    n_key_dump_target_state &&
    n_key_dump_entity_list &&
    n_key_debug_full &&
    n_key_debug_collision &&
    n_key_debug_console_connect &&
    n_key_debug_bounding_boxes &&
    n_key_debug_shaders &&
    n_key_debug_off &&
    _sysInfoLight.x &&
    selFunctionIdx &&
    stickFunctions &&
    keyFunctions &&
    customEquipActivation &&
    customActivatePressed &&
    customModePressed &&
    kbdLayouts &&
    showingLongRangeChart &&
    _missionAllowInterrupt &&
    _missionScreenID &&
    _missionTitle &&
    _missionTextEntry;
}

suppressTargetLost

- (void) suppressTargetLost

Reimplemented from ShipEntity.

switchHudTo:

- (BOOL) switchHudTo:

(NSString *)

hudFileName

Definition at line 13727 of file PlayerEntity.m.

                    :(NSString *)hudFileName
{
    NSDictionary    *hudDict = nil;
    BOOL            wasHidden = NO;
    BOOL            wasCompassActive = YES;
    double          scannerZoom = 1.0;
    NSUInteger      lastMFD = 0;
    NSUInteger      i;
 
    if (!hudFileName)  return NO;
    
    // is the HUD in the process of being rendered? If yes, set it to defer state and abort the switching now
    if (hud != nil && [hud isUpdating])
    {
        [hud setDeferredHudName:hudFileName];
        return NO;
    }
    
    hudDict = [ResourceManager dictionaryFromFilesNamed:hudFileName inFolder:@"Config" andMerge:YES];
    // hud defined, but buggy?
    if (hudDict == nil)
    {
        OOLog(@"PlayerEntity.switchHudTo.failed", @"HUD dictionary file %@ to switch to not found or invalid.", hudFileName);
        return NO;
    }
    
    if (hud != nil)
    {
        // remember these values
        wasHidden = [hud isHidden];
        wasCompassActive = [hud isCompassActive];
        scannerZoom = [hud scannerZoom];
        lastMFD = activeMFD;
    }
    
    // buggy oxp could override hud.plist with a non-dictionary.
    if (hudDict != nil)
    {
        [hud setHidden:YES];    // hide the hud while rebuilding it.
        DESTROY(hud);
        hud = [[HeadUpDisplay alloc] initWithDictionary:hudDict inFile:hudFileName];
        [hud resetGuis:hudDict];
        // reset zoom & hidden to what they were before the swich
        [hud setScannerZoom:scannerZoom];
        [hud setCompassActive:wasCompassActive];
        [hud setHidden:wasHidden];
        activeMFD = 0;
        NSArray *savedMFDs = [NSArray arrayWithArray:multiFunctionDisplaySettings];
        [multiFunctionDisplaySettings removeAllObjects];
        for (i = 0; i < [hud mfdCount] ; i++)
        {
            if ([savedMFDs count] > i)
            {
                [multiFunctionDisplaySettings addObject:[savedMFDs objectAtIndex:i]];
            }
            else
            {
                [multiFunctionDisplaySettings addObject:[NSNull null]];
            }
        }
        if (lastMFD < [hud mfdCount]) activeMFD = lastMFD;
    }
    
    return YES;
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

switchToMainView

- (void) switchToMainView

Provided by category PlayerEntity(Controls).

Definition at line 164 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];
}

switchToThisView:

- (void) switchToThisView: (OOViewID)  viewDirection

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

                         :(OOViewID)viewDirection
{
    [self switchToThisView:viewDirection andProcessWeaponFacing:YES];
}

switchToThisView:andProcessWeaponFacing:

- (void) switchToThisView: (OOViewID)  viewDirection andProcessWeaponFacing: (BOOL)  processWeaponFacing

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

                         :(OOViewID)viewDirection andProcessWeaponFacing:(BOOL)processWeaponFacing
{
    [self switchToThisView:viewDirection fromView:[UNIVERSE viewDirection] andProcessWeaponFacing:processWeaponFacing justNotify:NO];
}

switchToThisView:fromView:andProcessWeaponFacing:justNotify:

- (void) switchToThisView: (OOViewID)  viewDirection fromView: (OOViewID)  oldViewDirection andProcessWeaponFacing: (BOOL)  processWeaponFacing justNotify: (BOOL)  justNotify

implementation

Provided by category PlayerEntity(OOControlsPrivate).

Definition at line 4739 of file PlayerEntityControls.m.

                         :(OOViewID)viewDirection fromView:(OOViewID)oldViewDirection andProcessWeaponFacing:(BOOL)processWeaponFacing justNotify:(BOOL)justNotify
{
    if (!justNotify)
    {   
        if ([UNIVERSE displayGUI]) [self switchToMainView];
        [UNIVERSE setViewDirection:viewDirection];
    }
    if (processWeaponFacing)
    {
        OOWeaponFacing facing = WEAPON_FACING_NONE;
        switch (viewDirection)
        {
            case VIEW_FORWARD:
                facing = WEAPON_FACING_FORWARD;
                break;
                
            case VIEW_AFT:
                facing = WEAPON_FACING_AFT;
                break;
                
            case VIEW_PORT:
                facing = WEAPON_FACING_PORT;
                break;
                
            case VIEW_STARBOARD:
                facing = WEAPON_FACING_STARBOARD;
                break;
                
            default:
                break;
        }
        
        if (facing != WEAPON_FACING_NONE)
        {
            currentWeaponFacing = facing;
            [self currentWeaponStats];
        }
        else
        {
            OOLogERR(kOOLogParameterError, @"%s called with processWeaponFacing=YES for non-main view %i.", __FUNCTION__, viewDirection);
        }
    }
    if ((oldViewDirection != viewDirection || viewDirection == VIEW_CUSTOM) && ![[UNIVERSE gameController] isGamePaused])
    {
        JSContext *context = OOJSAcquireContext();
        ShipScriptEvent(context, self, "viewDirectionChanged", OOJSValueFromViewID(context, viewDirection), OOJSValueFromViewID(context, oldViewDirection));
        OOJSRelinquishContext(context);
    }
}

systemEconomy_number

- (NSNumber *) systemEconomy_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    NSDictionary *systeminfo = [UNIVERSE currentSystemData];
    return [systeminfo objectForKey:KEY_ECONOMY];
}

systemEconomy_string

- (NSString *) systemEconomy_string

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    int economy = [[self systemEconomy_number] intValue]; // 0 .. 7 (0 rich industrial .. 7 poor agricultural)
    NSString *result = OODisplayStringFromEconomyID(economy);
    if (result == nil) result = @"UNKNOWN";
    
    return result;
}

systemGovernment_number

- (NSNumber *) systemGovernment_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    NSDictionary *systeminfo = [UNIVERSE currentSystemData];
    return [systeminfo objectForKey:KEY_GOVERNMENT];
}

systemGovernment_string

- (NSString *) systemGovernment_string

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    int government = [[self systemGovernment_number] intValue]; // 0 .. 7 (0 anarchic .. 7 most stable)
    NSString *result = OODisplayStringFromGovernmentID(government);
    if (result == nil) result = @"UNKNOWN";
    
    return result;
}

systemID

- (OOSystemID) systemID

Definition at line 13727 of file PlayerEntity.m.

{
    return system_id;
}

systemPopulation_number

- (NSNumber *) systemPopulation_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    NSDictionary *systeminfo = [UNIVERSE currentSystemData];
    return [systeminfo objectForKey:KEY_POPULATION];
}

systemProductivity_number

- (NSNumber *) systemProductivity_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    NSDictionary *systeminfo = [UNIVERSE currentSystemData];
    return [systeminfo objectForKey:KEY_PRODUCTIVITY];
}

systemPseudoRandom100

- (unsigned) systemPseudoRandom100

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    seed_RNG_only_for_planet_description([[UNIVERSE systemManager] getRandomSeedForCurrentSystem]);
    return (gen_rnd_number() * 256 + gen_rnd_number()) % 100;
}

systemPseudoRandom256

- (unsigned) systemPseudoRandom256

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    seed_RNG_only_for_planet_description([[UNIVERSE systemManager] getRandomSeedForCurrentSystem]);
    return gen_rnd_number();
}

systemPseudoRandomFloat

- (double) systemPseudoRandomFloat

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    seed_RNG_only_for_planet_description([[UNIVERSE systemManager] getRandomSeedForCurrentSystem]);
    unsigned a = gen_rnd_number();
    unsigned b = gen_rnd_number();
    unsigned c = gen_rnd_number();
    
    a = (a << 16) | (b << 8) | c;
    return (double)a / (double)0x01000000;
    
}

systemTechLevel_number

- (NSNumber *) systemTechLevel_number

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    NSDictionary *systeminfo = [UNIVERSE currentSystemData];
    return [systeminfo objectForKey:KEY_TECHLEVEL];
}

takeEnergyDamage:from:becauseOf:weaponIdentifier:

- (void) takeEnergyDamage: (double)  amount from: (Entity *)  ent becauseOf: (Entity *)  other weaponIdentifier: (NSString *)  weaponIdentifier

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                         :(double)amount from:(Entity *)ent becauseOf:(Entity *)other weaponIdentifier:(NSString *)weaponIdentifier
{
    HPVector        rel_pos;
    OOScalar        d_forward, d_right, d_up;
    BOOL        internal_damage = NO;   // base chance
    
    OOLog(@"player.ship.damage",  @"Player took damage from %@ becauseOf %@", ent, other);
    
    if ([self status] == STATUS_DEAD)  return;
    if ([self status] == STATUS_ESCAPE_SEQUENCE) return; // if the player has ejected, don't deal more damage
    if (amount == 0.0)  return;
    
    BOOL cascadeWeapon = [ent isCascadeWeapon];
    BOOL cascading = NO;
    if (cascadeWeapon)
    {
        cascading = [self cascadeIfAppropriateWithDamageAmount:amount cascadeOwner:[ent owner]];
    }
    
    // make sure ent (& its position) is the attacking _ship_/missile !
    if (ent && [ent isSubEntity]) ent = [ent owner];
    
    [[ent retain] autorelease];
    [[other retain] autorelease];
    
    rel_pos = (ent != nil) ? [ent position] : kZeroHPVector;
    rel_pos = HPvector_subtract(rel_pos, position);
    
    [self doScriptEvent:OOJSID("shipBeingAttacked") withArgument:ent];
    if ([ent isShip]) [(ShipEntity *)ent doScriptEvent:OOJSID("shipAttackedOther") withArgument:self];
 
    d_forward = dot_product(HPVectorToVector(rel_pos), v_forward);
    d_right = dot_product(HPVectorToVector(rel_pos), v_right);
    d_up = dot_product(HPVectorToVector(rel_pos), v_up);
    Vector relative = make_vector(d_right,d_up,d_forward);
 
    [self playShieldHit:relative weaponIdentifier:weaponIdentifier];
 
    // firing on an innocent ship is an offence
    if ([other isShip])
    {
        [self broadcastHitByLaserFrom:(ShipEntity*) other];
    }
 
    if (d_forward >= 0)
    {
        forward_shield -= amount;
        if (forward_shield < 0.0)
        {
            amount = -forward_shield;
            forward_shield = 0.0f;
        }
        else
        {
            amount = 0.0;
        }
    }
    else
    {
        aft_shield -= amount;
        if (aft_shield < 0.0)
        {
            amount = -aft_shield;
            aft_shield = 0.0f;
        }
        else
        {
            amount = 0.0;
        }
    }
    
    OOShipDamageType damageType = cascadeWeapon ? kOODamageTypeCascadeWeapon : kOODamageTypeEnergy;
    
    if (amount > 0.0)
    {
        energy -= amount;
        [self playDirectHit:relative weaponIdentifier:weaponIdentifier];
        if (ship_temperature < SHIP_MAX_CABIN_TEMP)
        {
            /* Heat increase from energy impacts will never directly cause
             * overheating - too easy for missile hits to cause an uncredited
             * death by overheating against NPCs, so same rules for player */
            ship_temperature += amount * SHIP_ENERGY_DAMAGE_TO_HEAT_FACTOR / [self heatInsulation];
            if (ship_temperature > SHIP_MAX_CABIN_TEMP)
            {
                ship_temperature = SHIP_MAX_CABIN_TEMP;
            }
        }
    }
    [self noteTakingDamage:amount from:other type:damageType];
    if (cascading) energy = 0.0; // explicitly set energy to zero when cascading, in case an oxp raised the energy in noteTakingDamage.
    
    if (energy <= 0.0) //use normal ship temperature calculations for heat damage
    {
        if ([other isShip])
        {
            [(ShipEntity *)other noteTargetDestroyed:self];
        }
        
        [self getDestroyedBy:other damageType:damageType];
    }
    else
    {
        while (amount > 0.0)
        {
            internal_damage = ((ranrot_rand() & PLAYER_INTERNAL_DAMAGE_FACTOR) < amount);   // base chance of damage to systems
            if (internal_damage)
            {
                [self takeInternalDamage];
            }
            amount -= (PLAYER_INTERNAL_DAMAGE_FACTOR + 1);
        }
    }
}

takeHeatDamage:

- (void) takeHeatDamage: (double)  amount

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                       :(double) amount
{
    if ([self status] == STATUS_DEAD || amount < 0)  return;
    
    // hit the shields first!
    float fwd_amount = (float)(0.5 * amount);
    float aft_amount = (float)(0.5 * amount);
 
    forward_shield -= fwd_amount;
    if (forward_shield < 0.0)
    {
        fwd_amount = -forward_shield;
        forward_shield = 0.0f;
    }
    else
    {
        fwd_amount = 0.0f;
    }
 
    aft_shield -= aft_amount;
    if (aft_shield < 0.0)
    {
        aft_amount = -aft_shield;
        aft_shield = 0.0f;
    }
    else
    {
        aft_amount = 0.0f;
    }
 
    double residual_amount = fwd_amount + aft_amount;
    
    [super takeHeatDamage:residual_amount];
}

takeInternalDamage

- (BOOL) takeInternalDamage

Definition at line 13727 of file PlayerEntity.m.

{
    unsigned n_cargo = [self maxAvailableCargoSpace];
    unsigned n_mass = [self mass] / 10000;
    unsigned n_considered = (n_cargo + n_mass) * ship_trade_in_factor / 100; // a lower value of n_considered means more vulnerable to damage.
    unsigned damage_to = n_considered ? (ranrot_rand() % n_considered) : 0; // n_considered can be 0 for small ships.
    BOOL     result = NO;
    // cargo damage
    if (damage_to < [cargo count])
    {
        ShipEntity* pod = (ShipEntity*)[cargo objectAtIndex:damage_to];
        NSString* cargo_desc = [UNIVERSE displayNameForCommodity:[pod commodityType]];
        if (!cargo_desc)
            return NO;
        [UNIVERSE clearPreviousMessage];
        [UNIVERSE addMessage:[NSString stringWithFormat:DESC(@"@-destroyed"), cargo_desc] forCount:4.5];
        [cargo removeObject:pod];
        return YES;
    }
    else
    {
        damage_to = n_considered - (damage_to + 1); // reverse the die-roll
    }
    // equipment damage
    NSEnumerator *eqEnum = [self equipmentEnumerator];
    OOEquipmentType *eqType = nil;
    NSString        *system_key;
    unsigned damageableCounter = 0;
    GLfloat damageableOdds = 0.0;
    while ((system_key = [eqEnum nextObject]) != nil)
    {
        eqType = [OOEquipmentType equipmentTypeWithIdentifier:system_key];
        if ([eqType canBeDamaged])
        {
            damageableCounter++;
            damageableOdds += [eqType damageProbability];
        }
    }
 
    if (damage_to < damageableCounter)
    {
        GLfloat target = randf() * damageableOdds;
        GLfloat accumulator = 0.0;
        eqEnum = [self equipmentEnumerator];
        while ((system_key = [eqEnum nextObject]) != nil)
        {
            eqType = [OOEquipmentType equipmentTypeWithIdentifier:system_key];
            accumulator += [eqType damageProbability];
            if (accumulator > target) 
            {
                [system_key retain];
                break;
            }
        }
        if (system_key == nil)
        {
            [system_key release];
            return NO;
        }
 
        NSString        *system_name = [eqType name];
        if (![eqType canBeDamaged] || system_name == nil)
        {
            [system_key release];
            return NO;
        }
 
        // set the following so removeEquipment works on the right entity
        [self setScriptTarget:self];
        [UNIVERSE clearPreviousMessage];
        [self removeEquipmentItem:system_key];
 
        NSString *damagedKey = [NSString stringWithFormat:@"%@_DAMAGED", system_key];
        [self addEquipmentItem:damagedKey withValidation: NO inContext:@"damage"];  // for possible future repair.
        [self doScriptEvent:OOJSID("equipmentDamaged") withArgument:system_key];
            
        if (![self hasEquipmentItem:system_name] && [self hasEquipmentItem:damagedKey])
        {
            /*
                Display "foo damaged" message only if no script has
                repaired or removed the equipment item. (If a script does
                either of those and wants a message, it can write it
                itself.)
            */
            [UNIVERSE addMessage:[NSString stringWithFormat:DESC(@"@-damaged"), system_name] forCount:4.5];
        }
        
        /* There used to be a check for docking computers here, but
         * that didn't cover other ways they might fail in flight, so
         * it has been moved to the removeEquipment method. */
        [system_key release];
        return YES;
    }
    //cosmetic damage
    if (((damage_to & 7) == 7)&&(ship_trade_in_factor > 75))
    {
        ship_trade_in_factor--;
        result = YES;
    }
    return result;
}

Referenced by PlayerShipTakeInternalDamage().

Here is the caller graph for this function:

takeScrapeDamage:from:

- (void) takeScrapeDamage: (double)  amount from: (Entity *)  ent

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                         :(double) amount from:(Entity *) ent
{
    HPVector  rel_pos;
    OOScalar  d_forward, d_right, d_up;
    BOOL    internal_damage = NO;   // base chance
    
    if ([self status] == STATUS_DEAD)  return;
    
    if (amount < 0) 
    {
        OOLog(@"player.ship.damage",  @"Player took negative scrape damage %.3f so we made it positive", amount);
        amount = -amount;
    }
    OOLog(@"player.ship.damage",  @"Player took %.3f scrape damage from %@", amount, ent);
    
    [[ent retain] autorelease];
    rel_pos = ent ? [ent position] : kZeroHPVector;
    rel_pos = HPvector_subtract(rel_pos, position);
    // rel_pos is now small
    d_forward = dot_product(HPVectorToVector(rel_pos), v_forward);
    d_right = dot_product(HPVectorToVector(rel_pos), v_right);
    d_up = dot_product(HPVectorToVector(rel_pos), v_up);
    Vector relative = make_vector(d_right,d_up,d_forward);
 
    [self playScrapeDamage:relative];
    if (d_forward >= 0)
    {
        forward_shield -= amount;
        if (forward_shield < 0.0)
        {
            amount = -forward_shield;
            forward_shield = 0.0f;
        }
        else
        {
            amount = 0.0;
        }
    }
    else
    {
        aft_shield -= amount;
        if (aft_shield < 0.0)
        {
            amount = -aft_shield;
            aft_shield = 0.0f;
        }
        else
        {
            amount = 0.0;
        }
    }
    
    [super takeScrapeDamage:amount from:ent];
    
    while (amount > 0.0)
    {
        internal_damage = ((ranrot_rand() & PLAYER_INTERNAL_DAMAGE_FACTOR) < amount);   // base chance of damage to systems
        if (internal_damage)
        {
            [self takeInternalDamage];
        }
        amount -= (PLAYER_INTERNAL_DAMAGE_FACTOR + 1);
    }
}

targetInfoSystem

- (void) targetInfoSystem

Definition at line 13727 of file PlayerEntity.m.

{
    [self setInfoSystemID: target_system_id moveChart: YES];
    return;
}

targetMemory

- (NSMutableArray *) targetMemory

Definition at line 9242 of file PlayerEntity.m.

{
    return target_memory;
}

targetNearestHostile

- (void) targetNearestHostile

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    [self scanForHostiles];
    Entity *ent = [self foundTarget];
    if (ent != nil)
    {
        ident_engaged = YES;
        missile_status = MISSILE_STATUS_TARGET_LOCKED;
        [self addTarget:ent];
    }
}

targetNearestIncomingMissile

- (void) targetNearestIncomingMissile

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

{
    [self scanForNearestIncomingMissile];
    Entity *ent = [self foundTarget];
    if (ent != nil)
    {
        ident_engaged = YES;
        missile_status = MISSILE_STATUS_TARGET_LOCKED;
        [self addTarget:ent];
    }
}

targetNewSystem:

- (void) targetNewSystem:

(int)

direction

Provided by category PlayerEntity(Controls).

Definition at line 164 of file PlayerEntityControls.m.

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

targetNewSystem:whileTyping:

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

implementation

Provided by category PlayerEntity(Controls).

Definition at line 164 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;
}

targetSystemID

- (OOSystemID) targetSystemID

Definition at line 13727 of file PlayerEntity.m.

{
    return target_system_id;
}

testForEquipment:

- (void) testForEquipment:

(NSString *)

equipString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                         :(NSString *)equipString   //eg. EQ_NAVAL_ENERGY_UNIT
{
    found_equipment = [self hasEquipmentItem:equipString];
}

TestScriptConditions

+ (static BOOL) TestScriptConditions (NSArray *)  conditions

implementation

Provided by category PlayerEntity(Scripting).

Definition at line 233 of file PlayerEntityLegacyScriptEngine.m.

{
    NSEnumerator            *condEnum = nil;
    NSArray                 *condition = nil;
    PlayerEntity            *player = PLAYER;
    
    for (condEnum = [conditions objectEnumerator]; (condition = [condEnum nextObject]); )
    {
        if (![player scriptTestCondition:condition])  return NO;
    }
    
    return YES;
}

tidyMissilePylons

- (void) tidyMissilePylons

Definition at line 13727 of file PlayerEntity.m.

{
    // Make sure there's no gaps between missiles, synchronise missile_entity & missile_list.
    int i, pylon = 0;
    OOLog(@"missile.tidying.debug",@"Tidying fitted %d of possible %d missiles",missiles,PLAYER_MAX_MISSILES);
    for(i = 0; i < PLAYER_MAX_MISSILES; i++)
    {
        OOLog(@"missile.tidying.debug",@"%d %@ %@",i,missile_entity[i],missile_list[i]);
        if(missile_entity[i] != nil)
        {
            missile_entity[pylon] = missile_entity[i];
            missile_list[pylon] = [OOEquipmentType equipmentTypeWithIdentifier:[missile_entity[i] primaryRole]];
            pylon++;
        }
    }
 
    // Now clean up the remainder of the pylons.
    for(i = pylon; i < PLAYER_MAX_MISSILES; i++)
    {
        missile_entity[i] = nil;
        // not strictly needed, but helps clear things up
        missile_list[i] = nil;
    }
}

tradeInFactor

- (int) tradeInFactor

Definition at line 9242 of file PlayerEntity.m.

{
    return ship_trade_in_factor;
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

tradeInValue

- (OOCreditsQuantity) tradeInValue

implementation

Provided by category PlayerEntity(ContractsPrivate).

Definition at line 1443 of file PlayerEntityContracts.m.

{
    // returns down to ship_trade_in_factor% of the full credit value of your ship
    
    /*  FIXME: the trade-in value can be more than the sale value, and
        ship_trade_in_factor starts at 100%, so it can be profitable to sit
        and buy the same ship over and over again. This bug predates Oolite
        1.65.
        Partial fix: make effective trade-in value 75% * ship_trade_in_factor%
        of the "raw" trade-in value. This still allows profitability! A better
        solution would be to unify the price calculation for trade-in and
        for-sale ships.
        -- Ahruman 20070707, fix applied 20070708
    */
    unsigned long long value = [UNIVERSE tradeInValueForCommanderDictionary:[self commanderDataDictionary]];
    value -= value * 0.006 * [self missingSubEntitiesAdjustment];   // TODO: 0.006 might need rethinking.
    value = cunningFee(((value * 75 * ship_trade_in_factor) + 5000) / 10000, 0.005);    // Multiply by two percentages, divide by 100*100. The +5000 is to get normal rounding.
    return value * 10;
}

trumbleAppetiteAccumulator

- (float) trumbleAppetiteAccumulator

Definition at line 9242 of file PlayerEntity.m.

{
    return _trumbleAppetiteAccumulator;
}

trumbleArray

- (OOTrumble **) trumbleArray

Definition at line 9242 of file PlayerEntity.m.

{
    return trumble;
}

trumbleCount

- (NSUInteger) trumbleCount

trumbleValue

- (id) trumbleValue

Definition at line 9242 of file PlayerEntity.m.

{
    NSString    *namekey = [NSString stringWithFormat:@"%@-humbletrash", [self commanderName]];
    int         trumbleHash;
    
    clear_checksum();
    [self mungChecksumWithNSString:[self commanderName]];
    munge_checksum(credits);
    munge_checksum(ship_kills);
    trumbleHash = munge_checksum(trumbleCount);
    
    [[NSUserDefaults standardUserDefaults] setInteger:trumbleHash forKey:namekey];
    
    int i;
    NSMutableArray *trumbleArray = [NSMutableArray arrayWithCapacity:PLAYER_MAX_TRUMBLES];
    for (i = 0; i < PLAYER_MAX_TRUMBLES; i++)
    {
        [trumbleArray addObject:[trumble[i] dictionary]];
    }
    
    return [NSArray arrayWithObjects:[NSNumber numberWithUnsignedInteger:trumbleCount], [NSNumber numberWithInt:trumbleHash], trumbleArray, nil];
}

tryBuyingCommodity:all:

- (BOOL) tryBuyingCommodity:		(OOCommodityType)	type
all:		(BOOL)	all

Definition at line 9242 of file PlayerEntity.m.

                           :(OOCommodityType)index all:(BOOL)all
{
    if ([index isEqualToString:@"<<<"] || [index isEqualToString:@">>>"])
    {
        ++marketOffset;
        return NO;
    }
 
    if (![self isDocked])  return NO; // can't buy if not docked.
    
    OOCommodityMarket   *localMarket = [self localMarket];
    OOCreditsQuantity   pricePerUnit    = [localMarket priceForGood:index];
    OOMassUnit          unit            = [localMarket massUnitForGood:index];
 
    if (specialCargo != nil && unit == UNITS_TONS)
    {
        return NO;                                  // can't buy tons of stuff when carrying a specialCargo
    }
    int manifest_quantity = [shipCommodityData quantityForGood:index];
    int market_quantity = [localMarket quantityForGood:index];
    
    int purchase = 1;
    if (all)
    {
        // if cargo contracts, put a break point on the contract volume
        int contracted = [self contractedVolumeForGood:index];
        if (manifest_quantity >= contracted)
        {
            purchase = [localMarket capacityForGood:index];
        }
        else
        {
            purchase = contracted-manifest_quantity;
        }
    }
    if (purchase > market_quantity)
    {
        purchase = market_quantity;                 // limit to what's available
    }
    if (purchase * pricePerUnit > credits)
    {
        purchase = floor (credits / pricePerUnit);  // limit to what's affordable
    }
    // TODO - fix brokenness here...
    if (unit == UNITS_TONS && purchase + current_cargo > [self maxAvailableCargoSpace])
    {
        purchase = [self availableCargoSpace];      // limit to available cargo space
    }
    else
    {
        if (current_cargo == [self maxAvailableCargoSpace])
        {
            // other cases are fine so long as buying is limited to <1000kg / <1000000g
            // but if this case is true, we need to see if there is more space in
            // the manifest (safe) or an already-accounted-for pod
            if (unit == UNITS_KILOGRAMS)
            {
                if (manifest_quantity % KILOGRAMS_PER_POD <= MAX_KILOGRAMS_IN_SAFE && (manifest_quantity + purchase) % KILOGRAMS_PER_POD > MAX_KILOGRAMS_IN_SAFE)
                {
                    // going from < n500 to >= n500 would increase pods needed by 1
                    purchase = MAX_KILOGRAMS_IN_SAFE - manifest_quantity; // max possible
                }
            }
            else // UNITS_GRAMS
            {
                if (manifest_quantity % GRAMS_PER_POD <= MAX_GRAMS_IN_SAFE && (manifest_quantity + purchase) % GRAMS_PER_POD > MAX_GRAMS_IN_SAFE)
                {
                    // going from < n500000 to >= n500000 would increase pods needed by 1
                    purchase = MAX_GRAMS_IN_SAFE - manifest_quantity; // max possible
                }
            }
        }
    }
    if (purchase <= 0)
    {
        return NO;                                  // stop if that results in nothing to be bought
    }
    
    [localMarket removeQuantity:purchase forGood:index];
    [shipCommodityData addQuantity:purchase forGood:index];
    credits -= pricePerUnit * purchase;
 
    [self calculateCurrentCargo];
    
    if ([UNIVERSE autoSave])  [UNIVERSE setAutoSaveNow:YES];
    
    [self doScriptEvent:OOJSID("playerBoughtCargo") withArguments:[NSArray arrayWithObjects:index, [NSNumber numberWithInt:purchase], [NSNumber numberWithUnsignedLongLong:pricePerUnit], nil]];
    if ([localMarket exportLegalityForGood:index] > 0)
    {
        [roleWeightFlags setObject:[NSNumber numberWithInt:1] forKey:@"bought-illegal"];
    }
    else
    {
        [roleWeightFlags setObject:[NSNumber numberWithInt:1] forKey:@"bought-legal"];
    }
    
    return YES;
}

tryBuyingItem:

- (BOOL) tryBuyingItem: (NSString *)  eqKey

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 9242 of file PlayerEntity.m.

                      :(NSString *)eqKey
{
    // note this doesn't check the availability by tech-level
    OOEquipmentType         *eqType         = [OOEquipmentType equipmentTypeWithIdentifier:eqKey];
    OOCreditsQuantity       pricePerUnit    = [eqType price];
    NSString                *eqKeyDamaged   = [eqType damagedIdentifier];
    double                  price           = pricePerUnit;
    double                  priceFactor     = 1.0;
    OOCreditsQuantity       tradeIn         = 0;
    BOOL    isRepair = NO;
    
    // repairs cost 50%
    if ([self hasEquipmentItem:eqKeyDamaged])
    {
        price /= 2.0;
        isRepair = YES;
    }
    
    if ([eqKey isEqualToString:@"EQ_RENOVATION"])
    {
        price = [self renovationCosts];
    }
    
    price = [self adjustPriceByScriptForEqKey:eqKey withCurrent:price];
 
    StationEntity *dockedStation = [self dockedStation];
    if (dockedStation)
    {
        priceFactor = [dockedStation equipmentPriceFactor];
    }
    
    price *= priceFactor;  // increased prices at some stations
    
    if (price > credits)
    {
        return NO;
    }
    
    if ([eqType isPrimaryWeapon])
    {
        if (chosen_weapon_facing == WEAPON_FACING_NONE)
        {
            [self setGuiToEquipShipScreen:0 selectingFacingFor:eqKey];  // reset
            return YES;
        }
        
        OOWeaponType chosen_weapon = OOWeaponTypeFromEquipmentIdentifierStrict(eqKey);
        OOWeaponType current_weapon = nil;
 
        NSUInteger multiplier = 1;
        
        switch (chosen_weapon_facing)
        {
            case WEAPON_FACING_FORWARD:
                current_weapon = forward_weapon_type;
                forward_weapon_type = chosen_weapon;
                if (_multiplyWeapons)
                {
                    multiplier = [forwardWeaponOffset count];
                }
                break;
                
            case WEAPON_FACING_AFT:
                current_weapon = aft_weapon_type;
                aft_weapon_type = chosen_weapon;
                if (_multiplyWeapons)
                {
                    multiplier = [aftWeaponOffset count];
                }
                break;
                
            case WEAPON_FACING_PORT:
                current_weapon = port_weapon_type;
                port_weapon_type = chosen_weapon;
                if (_multiplyWeapons)
                {
                    multiplier = [portWeaponOffset count];
                }
                break;
                
            case WEAPON_FACING_STARBOARD:
                current_weapon = starboard_weapon_type;
                starboard_weapon_type = chosen_weapon;
                if (_multiplyWeapons)
                {
                    multiplier = [starboardWeaponOffset count];
                }
                break;
                
            case WEAPON_FACING_NONE:
                break;
        }
 
        price *= multiplier;
        
        if (price > credits)
        {
            // not enough money - ensure that weapon
            // type is reset to what it was before
            // the attempt to buy took place
            switch (chosen_weapon_facing)
            {
                case WEAPON_FACING_FORWARD:
                    forward_weapon_type = current_weapon;
                    break;
                case WEAPON_FACING_AFT:
                    aft_weapon_type = current_weapon;
                    break;
                case WEAPON_FACING_PORT:
                    port_weapon_type = current_weapon;
                    break;
                case WEAPON_FACING_STARBOARD:
                    starboard_weapon_type = current_weapon;
                    break;
                case WEAPON_FACING_NONE:
                    break;
            }
            return NO;
        }
        credits -= price;
        
        // Refund current_weapon
        if (current_weapon != nil)
        {
            tradeIn = [UNIVERSE getEquipmentPriceForKey:OOEquipmentIdentifierFromWeaponType(current_weapon)] * multiplier;
        }
        
        [self doTradeIn:tradeIn forPriceFactor:priceFactor];
        // If equipped, remove damaged weapon after repairs. -- But there's no way we should get a damaged weapon. Ever.
        [self removeEquipmentItem:eqKeyDamaged];
        return YES;
    }
    
    if ([eqType isMissileOrMine] && missiles >= max_missiles)
    {
        OOLog(@"equip.buy.mounted.failed.full", @"%@", @"rejecting missile because already full");
        return NO;
    }
    
    // NSFO!
    //unsigned  passenger_space = [[OOEquipmentType equipmentTypeWithIdentifier:@"EQ_PASSENGER_BERTH"] requiredCargoSpace];
    //if (passenger_space == 0) passenger_space = PASSENGER_BERTH_SPACE;
    
    if ([eqKey isEqualToString:@"EQ_PASSENGER_BERTH"] && [self availableCargoSpace] < PASSENGER_BERTH_SPACE)
    {
        return NO;
    }
    
    if ([eqKey isEqualToString:@"EQ_FUEL"])
    {
#if MASS_DEPENDENT_FUEL_PRICES
        OOCreditsQuantity creditsForRefuel = ([self fuelCapacity] - [self fuel]) * pricePerUnit * [self fuelChargeRate];
#else
        OOCreditsQuantity creditsForRefuel = ([self fuelCapacity] - [self fuel]) * pricePerUnit;
#endif
        if (credits >= creditsForRefuel)    // Ensure we don't overflow
        {
            credits -= creditsForRefuel;
            fuel = [self fuelCapacity];
            return YES;
        }
        else
        {
            return NO;
        }
    }
    
    // check energy unit replacement
    if ([eqKey hasSuffix:@"ENERGY_UNIT"] && [self energyUnitType] != ENERGY_UNIT_NONE)
    {
        switch ([self energyUnitType])
        {
            case ENERGY_UNIT_NAVAL :
                [self removeEquipmentItem:@"EQ_NAVAL_ENERGY_UNIT"];
                tradeIn = [UNIVERSE getEquipmentPriceForKey:@"EQ_NAVAL_ENERGY_UNIT"] / 2;   // 50 % refund
                break;
            case ENERGY_UNIT_NAVAL_DAMAGED :
                [self removeEquipmentItem:@"EQ_NAVAL_ENERGY_UNIT_DAMAGED"];
                tradeIn = [UNIVERSE getEquipmentPriceForKey:@"EQ_NAVAL_ENERGY_UNIT"] / 4;   // half of the working one
                break;
            case ENERGY_UNIT_NORMAL :
                [self removeEquipmentItem:@"EQ_ENERGY_UNIT"];
                tradeIn = [UNIVERSE getEquipmentPriceForKey:@"EQ_ENERGY_UNIT"] * 3 / 4;     // 75 % refund
                break;
            case ENERGY_UNIT_NORMAL_DAMAGED :
                [self removeEquipmentItem:@"EQ_ENERGY_UNIT_DAMAGED"];
                tradeIn = [UNIVERSE getEquipmentPriceForKey:@"EQ_ENERGY_UNIT"] * 3 / 8;     // half of the working one
                break;
 
            default:
                break;
        }
        [self doTradeIn:tradeIn forPriceFactor:priceFactor];
    }
    
    // maintain ship
    if ([eqKey isEqualToString:@"EQ_RENOVATION"])
    {
        OOTechLevelID techLevel = NSNotFound;
        if (dockedStation != nil)  techLevel = [dockedStation equivalentTechLevel];
        if (techLevel == NSNotFound)  techLevel = [[UNIVERSE currentSystemData] oo_unsignedIntForKey:KEY_TECHLEVEL];
        
        credits -= price;
        ship_trade_in_factor += 5 + techLevel;  // you get better value at high-tech repair bases
        if (ship_trade_in_factor > 100) ship_trade_in_factor = 100;
        
        [self clearSubEntities];
        [self setUpSubEntities];
        
        return YES;
    }
    
    if ([eqKey hasSuffix:@"MISSILE"] || [eqKey hasSuffix:@"MINE"])
    {
        ShipEntity* weapon = [[UNIVERSE newShipWithRole:eqKey] autorelease];
        if (weapon)  OOLog(kOOLogBuyMountedOK, @"Got ship for mounted weapon role %@", eqKey);
        else  OOLog(kOOLogBuyMountedFailed, @"Could not find ship for mounted weapon role %@", eqKey);
        
        BOOL mounted_okay = [self mountMissile:weapon];
        if (mounted_okay)
        {
            credits -= price;
            [self safeAllMissiles];
            [self tidyMissilePylons];
            [self setActiveMissile:0];
        }
        return mounted_okay;
    }
    
    if ([eqKey isEqualToString:@"EQ_PASSENGER_BERTH"])
    {
        [self changePassengerBerths:+1];
        credits -= price;
        return YES;
    }
    
    if ([eqKey isEqualToString:@"EQ_PASSENGER_BERTH_REMOVAL"])
    {
        [self changePassengerBerths:-1];
        credits -= price;
        return YES;
    }
    
    if ([eqKey isEqualToString:@"EQ_MISSILE_REMOVAL"])
    {
        credits -= price;
        tradeIn += [self removeMissiles];
        [self doTradeIn:tradeIn forPriceFactor:priceFactor];
        return YES;
    }
    
    if ([self canAddEquipment:eqKey inContext:@"purchase"])
    {
        credits -= price;
        [self addEquipmentItem:eqKey withValidation:NO inContext:@"purchase"]; // no need to validate twice.
        if (isRepair)
        {
            [self doScriptEvent:OOJSID("equipmentRepaired") withArgument:eqKey];
        }
        return YES;
    }
    
    return NO;
}

trySellingCommodity:all:

- (BOOL) trySellingCommodity:		(OOCommodityType)	type
all:		(BOOL)	all

Definition at line 9242 of file PlayerEntity.m.

                            :(OOCommodityType)index all:(BOOL)all
{
    if ([index isEqualToString:@"<<<"] || [index isEqualToString:@">>>"])
    {
        --marketOffset;
        return NO;
    }
 
    if (![self isDocked])  return NO; // can't sell if not docked.
    
    OOCommodityMarket *localMarket = [self localMarket];
    int available_units = [shipCommodityData quantityForGood:index];
    OOCreditsQuantity pricePerUnit = [localMarket priceForGood:index];
    
    if (available_units == 0)  return NO;
 
    int market_quantity = [localMarket quantityForGood:index];
 
    int capacity = [localMarket capacityForGood:index];
    int sell = 1;
    if (all)
    {
        // if cargo contracts, put a break point on the contract volume
        int contracted = [self contractedVolumeForGood:index];
        if (available_units <= contracted)
        {
            sell = capacity;
        }
        else
        {
            sell = available_units-contracted;
        }
    }
 
    if (sell > available_units)
        sell = available_units;                 // limit to what's in the hold
    if (sell + market_quantity > capacity)
        sell = capacity - market_quantity;          // avoid flooding the market
    if (sell <= 0)
        return NO;                              // stop if that results in nothing to be sold
    
    [localMarket addQuantity:sell forGood:index];
    [shipCommodityData removeQuantity:sell forGood:index];
    credits += pricePerUnit * sell;
 
    [self calculateCurrentCargo];
    
    if ([UNIVERSE autoSave]) [UNIVERSE setAutoSaveNow:YES];
    
    [self doScriptEvent:OOJSID("playerSoldCargo") withArguments:[NSArray arrayWithObjects:index, [NSNumber numberWithInt:sell], [NSNumber numberWithUnsignedLongLong: pricePerUnit], nil]];
    
    return YES;
}

unloadAllCargoPodsForType:toManifest:

- (void) unloadAllCargoPodsForType:		(OOCommodityType)	type
toManifest:		(OOCommodityMarket *)	manifest

Definition at line 13727 of file PlayerEntity.m.

                                  :(OOCommodityType)type toManifest:(OOCommodityMarket *) manifest
{
    NSInteger i, cargoCount = [cargo count];
    if (cargoCount == 0)  return;
    
    // step through the cargo pods adding in the quantities 
    for (i =  cargoCount - 1; i >= 0 ; i--)
    {
        ShipEntity *cargoItem = [cargo objectAtIndex:i];
        NSString * commodityType = [cargoItem commodityType];
        if (commodityType == nil || [commodityType isEqualToString:type])
        {
            if ([commodityType isEqualToString:type])
            {
                // transfer
                [manifest addQuantity:[cargoItem commodityAmount] forGood:type];
            }
            else    // undefined
            {
                OOLog(@"player.badCargoPod", @"Cargo pod %@ has bad commodity type, rejecting.", cargoItem);
                continue;
            }
            [cargo removeObjectAtIndex:i];
        }
    }
}

unloadCargoPods

- (void) unloadCargoPods

Definition at line 13727 of file PlayerEntity.m.

{
    NSAssert([self isDocked], @"Cannot unload cargo pods unless docked.");
    
    /* loads commodities from the cargo pods onto the ship's manifest */
    NSString *good = nil;
    foreach (good, [shipCommodityData goods])
    {
        [self unloadAllCargoPodsForType:good toManifest:shipCommodityData];
    }
#ifndef NDEBUG
    if ([cargo count] > 0)
    {
        OOLog(@"player.unloadCargo",@"Cargo remains in pods after unloading - %@",cargo);
    }
#endif
 
    [self calculateCurrentCargo];   // work out the correct value for current_cargo
}

unloadCargoPodsForType:amount:

- (void) unloadCargoPodsForType:		(OOCommodityType)	type
amount:		(OOCargoQuantity)	quantity

Definition at line 13727 of file PlayerEntity.m.

                               :(OOCommodityType)type amount:(OOCargoQuantity)quantity
{
    NSInteger           i, n_cargo = [cargo count];
    if (n_cargo == 0)  return;
    
    ShipEntity          *cargoItem = nil;
    OOCommodityType     co_type;
    OOCargoQuantity     amount;
    OOCargoQuantity     cargoToGo = quantity;
 
    // step through the cargo pods removing pods or quantities  
    for (i =  n_cargo - 1; (i >= 0 && cargoToGo > 0) ; i--)
    {
        cargoItem = [cargo objectAtIndex:i];
        co_type = [cargoItem commodityType];
        if (co_type == nil || [co_type isEqualToString:type])
        {
            if ([co_type isEqualToString:type])
            {
                amount =  [cargoItem commodityAmount];
                if (amount <= cargoToGo)
                {
                    [cargo removeObjectAtIndex:i];
                    cargoToGo -= amount;
                }
                else
                {
                    // we only need to remove a part of the cargo to meet our target
                    [cargoItem setCommodity:co_type andAmount:(amount - cargoToGo)];
                    cargoToGo = 0;
                    
                }
            }
            else    // undefined
            {
                OOLog(@"player.badCargoPod", @"Cargo pod %@ has bad commodity type (COMMODITY_UNDEFINED), rejecting.", cargoItem);
                continue;
            }
        }
    }
    
    // now check if we are ready. When not, proceed with quantities in the manifest.
    if (cargoToGo > 0)
    {
        [shipCommodityData removeQuantity:cargoToGo forGood:type];
    }
}

unsetKeySetting:

- (void) unsetKeySetting: (NSString*)  key

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                        :(NSString*)key
{
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    if (![self entryIsCustomEquip:key])
    {
        NSMutableDictionary *keyconf = [NSMutableDictionary dictionaryWithDictionary:[defaults objectForKey:KEYCONFIG_OVERRIDES]];
        NSMutableArray *empty = [[NSMutableArray alloc] init];
        [keyconf setObject:empty forKey:key];
        [defaults setObject:keyconf forKey:KEYCONFIG_OVERRIDES];
        [empty release];
    }
    else 
    {
        NSString *custkey = [self getCustomEquipKeyDefType:key];
        NSMutableDictionary *custEquip = [[customEquipActivation objectAtIndex:[self getCustomEquipIndex:key]] mutableCopy];
        [custEquip removeObjectForKey:custkey];
        [customEquipActivation replaceObjectAtIndex:[self getCustomEquipIndex:key] withObject:custEquip];
        [defaults setObject:customEquipActivation forKey:KEYCONFIG_CUSTOMEQUIP];
        [custEquip release];
    }
    // reload settings
    [self initKeyConfigSettings];
}

update:

- (void) update: (OOTimeDelta)  delta_t

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

               :(OOTimeDelta)delta_t
{
    STAGE_TRACKING_BEGIN
    
    UPDATE_STAGE(@"updateMovementFlags");
    [self updateMovementFlags];
    UPDATE_STAGE(@"updateAlertCondition");
    [self updateAlertCondition];
    UPDATE_STAGE(@"updateFuelScoops:");
    [self updateFuelScoops:delta_t];
    
    UPDATE_STAGE(@"updateClocks:");
    [self updateClocks:delta_t];
    
    // scripting
    UPDATE_STAGE(@"updateTimers");
    [OOScriptTimer updateTimers];
    UPDATE_STAGE(@"checkScriptsIfAppropriate");
    [self checkScriptsIfAppropriate];
    
    // deal with collisions
    UPDATE_STAGE(@"manageCollisions");
    [self manageCollisions];
    
    UPDATE_STAGE(@"pollControls:");
    [self pollControls:delta_t];
    
    UPDATE_STAGE(@"updateTrumbles:");
    [self updateTrumbles:delta_t];
    
    OOEntityStatus status = [self status];
    /* Validate that if the status is STATUS_START_GAME we're on one
     * of the few GUI screens which that makes sense for */
    if (EXPECT_NOT(status == STATUS_START_GAME && 
                   gui_screen != GUI_SCREEN_INTRO1 && 
                   gui_screen != GUI_SCREEN_SHIPLIBRARY && 
                   gui_screen != GUI_SCREEN_GAMEOPTIONS && 
                   gui_screen != GUI_SCREEN_STICKMAPPER && 
                   gui_screen != GUI_SCREEN_STICKPROFILE && 
                   gui_screen != GUI_SCREEN_NEWGAME && 
                   gui_screen != GUI_SCREEN_OXZMANAGER && 
                   gui_screen != GUI_SCREEN_LOAD && 
                   gui_screen != GUI_SCREEN_KEYBOARD && 
                   gui_screen != GUI_SCREEN_KEYBOARD_CONFIRMCLEAR &&
                   gui_screen != GUI_SCREEN_KEYBOARD_CONFIG &&
                   gui_screen != GUI_SCREEN_KEYBOARD_ENTRY &&
                   gui_screen != GUI_SCREEN_KEYBOARD_LAYOUT))
    {
        // and if not, do a restart of the GUI
        UPDATE_STAGE(@"setGuiToIntroFirstGo:");
        [self setGuiToIntroFirstGo:YES];    //set up demo mode
    }
    
    if (status == STATUS_AUTOPILOT_ENGAGED || status == STATUS_ESCAPE_SEQUENCE)
    {
        UPDATE_STAGE(@"performAutopilotUpdates:");
        [self performAutopilotUpdates:delta_t];
    }
    else  if (![self isDocked])
    {
        UPDATE_STAGE(@"performInFlightUpdates:");
        [self performInFlightUpdates:delta_t];
    }
    
    /*  NOTE: status-contingent updates are not a switch since they can
        cascade when status changes.
    */
    if (status == STATUS_IN_FLIGHT)
    {
        UPDATE_STAGE(@"doBookkeeping:");
        [self doBookkeeping:delta_t];
    }
    if (status == STATUS_WITCHSPACE_COUNTDOWN)
    {
        UPDATE_STAGE(@"performWitchspaceCountdownUpdates:");
        [self performWitchspaceCountdownUpdates:delta_t];
    }
    if (status == STATUS_EXITING_WITCHSPACE)
    {
        UPDATE_STAGE(@"performWitchspaceExitUpdates:");
        [self performWitchspaceExitUpdates:delta_t];
    }
    if (status == STATUS_LAUNCHING)
    {
        UPDATE_STAGE(@"performLaunchingUpdates:");
        [self performLaunchingUpdates:delta_t];
    }
    if (status == STATUS_DOCKING)
    {
        UPDATE_STAGE(@"performDockingUpdates:");
        [self performDockingUpdates:delta_t];
    }
    if (status == STATUS_DEAD)
    {
        UPDATE_STAGE(@"performDeadUpdates:");
        [self performDeadUpdates:delta_t];
    }
    
    UPDATE_STAGE(@"updateWormholes");
    [self updateWormholes];
    
    STAGE_TRACKING_END
}

updateAfterburnerSound

- (void) updateAfterburnerSound

implementation

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

{
    static uint8_t which = 0;
    
    if (!afterburner_engaged)               // end the loop cycle
    {
        afterburnerSoundLooping = NO;
    }
    
    if (afterburnerSoundLooping)
    {
        [sAfterburnerSources[which] play];
        which = !which;
        
        [self performSelector:@selector(updateAfterburnerSound)
                   withObject:NULL
                   afterDelay:1.25];    // and swap sounds in 1.25s time
    }
}

updateAlertCondition

- (void) updateAlertCondition

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    [self updateAlertConditionForNearbyEntities];
    /*  TODO: update alert condition once per frame. Tried this before, but
        there turned out to be complications. See mailing list archive.
        -- Ahruman 20070802
     */
    OOAlertCondition cond = [self alertCondition];
    OOTimeAbsolute t = [UNIVERSE getTime];
    if (cond != lastScriptAlertCondition)
    {
        ShipScriptEventNoCx(self, "alertConditionChanged", INT_TO_JSVAL(cond), INT_TO_JSVAL(lastScriptAlertCondition));
        lastScriptAlertCondition = cond;
    }
    /* Update heuristic assessment of whether player is fleeing */
    if (cond == ALERT_CONDITION_DOCKED || cond == ALERT_CONDITION_GREEN || (cond == ALERT_CONDITION_YELLOW && energy == maxEnergy))
    {
        fleeing_status = PLAYER_FLEEING_NONE;
    }
    else if (fleeing_status == PLAYER_FLEEING_UNLIKELY && (energy > maxEnergy*0.6 || cond != ALERT_CONDITION_RED))
    {
        fleeing_status = PLAYER_FLEEING_NONE;
    }
    else if ((fleeing_status == PLAYER_FLEEING_MAYBE || fleeing_status == PLAYER_FLEEING_UNLIKELY) && cargo_dump_time > last_shot_time)
    {
        fleeing_status = PLAYER_FLEEING_CARGO;
    }
    else if (fleeing_status == PLAYER_FLEEING_MAYBE && last_shot_time + 10 > t)
    {
        fleeing_status = PLAYER_FLEEING_NONE;
    }
    else if (fleeing_status == PLAYER_FLEEING_LIKELY && last_shot_time + 10 > t)
    {
        fleeing_status = PLAYER_FLEEING_UNLIKELY;
    }
    else if (fleeing_status == PLAYER_FLEEING_NONE && cond == ALERT_CONDITION_RED && last_shot_time + 10 < t && flightSpeed > 0.75*maxFlightSpeed)
    {
        fleeing_status = PLAYER_FLEEING_MAYBE;
    }
    else if ((fleeing_status == PLAYER_FLEEING_MAYBE || fleeing_status == PLAYER_FLEEING_CARGO) && cond == ALERT_CONDITION_RED && last_shot_time + 10 < t && flightSpeed > 0.75*maxFlightSpeed && energy < maxEnergy * 0.5 && (forward_shield < [self maxForwardShieldLevel]*0.25 || aft_shield < [self maxAftShieldLevel]*0.25))
    {
        fleeing_status = PLAYER_FLEEING_LIKELY;
    }
}

updateAlertConditionForNearbyEntities

- (void) updateAlertConditionForNearbyEntities

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    if (![self isInSpace] || [self status] == STATUS_DOCKING)
    {
        [self clearAlertFlags];
        // not needed while docked
        return;
    }
 
    int             i, ent_count    = UNIVERSE->n_entities;
    Entity          **uni_entities  = UNIVERSE->sortedEntities; // grab the public sorted list
    Entity          *my_entities[ent_count];
    Entity          *scannedEntity = nil;
    for (i = 0; i < ent_count; i++)
    {
        my_entities[i] = [uni_entities[i] retain];  // retained
    }
    BOOL massLocked = NO;
    BOOL foundHostiles = NO;
#if OO_VARIABLE_TORUS_SPEED
    BOOL needHyperspeedNearest = YES;
    double hsnDistance = 0;
#endif
    for (i = 0; i < ent_count; i++)  // scanner lollypops
    {
        scannedEntity = my_entities[i];
 
#if OO_VARIABLE_TORUS_SPEED
        if (EXPECT_NOT(needHyperspeedNearest))
        {
            // not visual effects, waypoints, ships, etc.
            if (scannedEntity != self && [scannedEntity canCollide] && (![scannedEntity isShip] || ![self collisionExceptedFor:(ShipEntity *) scannedEntity]))
            {
                hsnDistance = sqrt(scannedEntity->zero_distance)-[scannedEntity collisionRadius];
                needHyperspeedNearest = NO;
            }
        } 
        else if ([scannedEntity isStellarObject])
        {
            // planets, stars might be closest surface even if not
            // closest centre. That could be true of others, but the
            // error is negligible there.
            double thisHSN = sqrt(scannedEntity->zero_distance)-[scannedEntity collisionRadius];
            if (thisHSN < hsnDistance)
            {
                hsnDistance = thisHSN;
            }
        }
#endif
        
        if (scannedEntity->zero_distance < SCANNER_MAX_RANGE2 || !scannedEntity->isShip)
        {
            int theirClass = [scannedEntity scanClass];
            // here we could also force masslock for higher than yellow alert, but
            // if we are going to hand over masslock control to scripting, might as well
            // hand it over fully
            if ([self massLockable] /*|| alertFlags > ALERT_FLAG_YELLOW_LIMIT*/)
            {
                massLocked |= [self checkEntityForMassLock:scannedEntity withScanClass:theirClass]; // we just need one masslocker..
            }
            if (theirClass != CLASS_NO_DRAW)
            {
                if (theirClass == CLASS_THARGOID || [scannedEntity isCascadeWeapon])
                {
                    foundHostiles = YES;
                }
                else if ([scannedEntity isShip])
                {
                    ShipEntity *ship = (ShipEntity *)scannedEntity;
                    foundHostiles |= (([ship hasHostileTarget])&&([ship primaryTarget] == self));
                }
            }
        }
    }
#if OO_VARIABLE_TORUS_SPEED
    if (EXPECT_NOT(needHyperspeedNearest))
    {
        // this case should only occur in an otherwise empty
        // interstellar space - unlikely but possible
        hyperspeedFactor = MIN_HYPERSPEED_FACTOR;
    }
    else
    {
        // once nearest object is >4x scanner range
        // start increasing torus speed
        double factor = hsnDistance/(4*SCANNER_MAX_RANGE);
        if (factor < 1.0)
        {
            hyperspeedFactor = MIN_HYPERSPEED_FACTOR;
        }
        else
        {
            hyperspeedFactor = MIN_HYPERSPEED_FACTOR * sqrt(factor);
            if (hyperspeedFactor > MAX_HYPERSPEED_FACTOR)
            {
                // caps out at ~10^8m from nearest object
                // which takes ~10 minutes of flying
                hyperspeedFactor = MAX_HYPERSPEED_FACTOR;
            }
        }
    }
#endif
 
    [self setAlertFlag:ALERT_FLAG_MASS_LOCK to:massLocked];
        
    [self setAlertFlag:ALERT_FLAG_HOSTILES to:foundHostiles];
 
    for (i = 0; i < ent_count; i++)
    {
        [my_entities[i] release];   //  released
    }
    
    BOOL energyCritical = NO;
    if (energy < 64 && energy < maxEnergy * 0.8)
    {
        energyCritical = YES;
    }
    [self setAlertFlag:ALERT_FLAG_ENERGY to:energyCritical];
 
    [self setAlertFlag:ALERT_FLAG_TEMP to:([self hullHeatLevel] > .90)];
 
    [self setAlertFlag:ALERT_FLAG_ALT to:([self dialAltitude] < .10)];
 
}

updateClocks:

- (void) updateClocks: (OOTimeDelta)  delta_t

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                     :(OOTimeDelta)delta_t
{
    // shot time updates are still needed here for STATUS_DEAD!
    shot_time += delta_t;
    script_time += delta_t;
    unsigned prev_day = floor(ship_clock / 86400);
    ship_clock += delta_t;
    if (ship_clock_adjust > 0.0)                // adjust for coming out of warp (add LY * LY hrs)
    {
        double fine_adjust = delta_t * 7200.0;
        if (ship_clock_adjust > 86400)          // more than a day
            fine_adjust = delta_t * 115200.0;   // 16 times faster
        if (ship_clock_adjust > 0)
        {
            if (fine_adjust > ship_clock_adjust)
                fine_adjust = ship_clock_adjust;
            ship_clock += fine_adjust;
            ship_clock_adjust -= fine_adjust;
        }
        else
        {
            if (fine_adjust < ship_clock_adjust)
                fine_adjust = ship_clock_adjust;
            ship_clock -= fine_adjust;
            ship_clock_adjust += fine_adjust;
        }
    }
    else 
        ship_clock_adjust = 0.0;
    
    unsigned now_day = floor(ship_clock / 86400.0);
    while (prev_day < now_day)
    {
        prev_day++;
        [self doScriptEvent:OOJSID("dayChanged") withArgument:[NSNumber numberWithUnsignedInt:prev_day]];
        // not impossible that at ultra-low frame rates two of these will
        // happen in a single update.
    }
 
    //fps
    if (ship_clock > fps_check_time)
    {
        if (![self clockAdjusting])
        {
            fps_counter = (int)([UNIVERSE timeAccelerationFactor] * floor([UNIVERSE framesDoneThisUpdate] / (fps_check_time - last_fps_check_time)));
            last_fps_check_time = fps_check_time;
            fps_check_time = ship_clock + MINIMUM_GAME_TICK;
        }
        else
        {
            // Good approximation for when the clock is adjusting and proper fps calculation
            // cannot be performed.
            fps_counter = (int)([UNIVERSE timeAccelerationFactor] * floor(1.0 / delta_t));
            fps_check_time = ship_clock + MINIMUM_GAME_TICK;
        }
        [UNIVERSE resetFramesDoneThisUpdate];   // Reset frame counter
    }
}

updateFuelScoops:

- (void) updateFuelScoops: (OOTimeDelta)  delta_t

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                         :(OOTimeDelta)delta_t
{
    if (scoopsActive)
    {
        [self updateFuelScoopSoundWithInterval:delta_t];
        if (![self scoopOverride])
        {
            scoopsActive = NO;
            [self updateFuelScoopSoundWithInterval:delta_t];
        }
    }
}

updateFuelScoopSoundWithInterval:

- (void) updateFuelScoopSoundWithInterval:

(OOTimeDelta)

delta_t

Provided by category PlayerEntity(Sound).

Definition at line 69 of file PlayerEntitySound.m.

                                         :(OOTimeDelta)delta_t
{
    static double scoopSoundPlayTime = 0.0;
    scoopSoundPlayTime -= delta_t;
    if (scoopSoundPlayTime < 0.0)
    {
        if(![sInterfaceBeepSource isPlaying])
        {
        /* TODO: this should use the scoop position, not the standard
         * interface beep position */
            [self playInterfaceBeep:@"[scoop]"];
            scoopSoundPlayTime = 0.5;
        }
        else scoopSoundPlayTime = 0.0;
    }
    if (![self scoopOverride])
    {
        scoopSoundPlayTime = 0.0;
    }
}

updateFunction:

- (void) updateFunction:

(NSDictionary *)

hwDict

Provided by category PlayerEntity(StickMapper).

Definition at line 1 of file PlayerEntityStickMapper.m.

                       : (NSDictionary *)hwDict
{
    OOJoystickManager   *stickHandler = [OOJoystickManager sharedStickHandler];
    waitingForStickCallback = NO;
    
    // Right time and the right place?
    if(gui_screen != GUI_SCREEN_STICKMAPPER)
    {
        OOLog(@"joystick.configure.error", @"%s called when not on stick mapper screen.", __PRETTY_FUNCTION__);
        return;
    }
    // What moved?
    int function;
    NSDictionary *entry = [stickFunctions objectAtIndex:selFunctionIdx];
    if([hwDict oo_boolForKey:STICK_ISAXIS])
    {
        function=[entry oo_intForKey: KEY_AXISFN];
        if (function == AXIS_THRUST)
        {
            [stickHandler unsetButtonFunction:BUTTON_INCTHRUST];
            [stickHandler unsetButtonFunction:BUTTON_DECTHRUST];
        }
#if OO_FOV_INFLIGHT_CONTROL_ENABLED
        if (function == AXIS_FIELD_OF_VIEW)
        {
            [stickHandler unsetButtonFunction:BUTTON_INC_FIELD_OF_VIEW];
            [stickHandler unsetButtonFunction:BUTTON_DEC_FIELD_OF_VIEW];
        }
#endif
        if (function == AXIS_VIEWX)
        {
            [stickHandler unsetButtonFunction:BUTTON_VIEWPORT];
            [stickHandler unsetButtonFunction:BUTTON_VIEWSTARBOARD];
        }
        if (function == AXIS_VIEWY)
        {
            [stickHandler unsetButtonFunction:BUTTON_VIEWFORWARD];
            [stickHandler unsetButtonFunction:BUTTON_VIEWAFT];
        }
    }
    else
    {
        function = [entry oo_intForKey:KEY_BUTTONFN];
        if (function == BUTTON_INCTHRUST || function == BUTTON_DECTHRUST)
        {
            [stickHandler unsetAxisFunction:AXIS_THRUST];
        }
#if OO_FOV_INFLIGHT_CONTROL_ENABLED
        if (function == BUTTON_INC_FIELD_OF_VIEW || function == BUTTON_DEC_FIELD_OF_VIEW)
        {
            [stickHandler unsetAxisFunction:AXIS_FIELD_OF_VIEW];
        }
#endif
        if (function == BUTTON_VIEWPORT || function == BUTTON_VIEWSTARBOARD)
        {
            [stickHandler unsetAxisFunction:AXIS_VIEWX];
        }
        if (function == BUTTON_VIEWFORWARD || function == BUTTON_VIEWAFT)
        {
            [stickHandler unsetAxisFunction:AXIS_VIEWY];
        }
    }
    // special case for OXP equipment buttons
    if (function >= 10000) 
    {
        NSString *key = CUSTOMEQUIP_BUTTONACTIVATE;
        function -= 10000;
        if (function >= 10000) 
        {
            function -= 10000;
            key = CUSTOMEQUIP_BUTTONMODE;
        }
        NSMutableDictionary *custEquip = [[customEquipActivation objectAtIndex:function] mutableCopy];
        [custEquip setObject:hwDict forKey:key];
        [customEquipActivation replaceObjectAtIndex:function withObject:custEquip];
        [custEquip release];
        [self checkCustomEquipButtons:hwDict ignore:function];
        NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
        [defaults setObject:customEquipActivation forKey:KEYCONFIG_CUSTOMEQUIP];
    }
    else 
    {
        [stickHandler setFunction:function withDict:hwDict];
        [self checkCustomEquipButtons:hwDict ignore:-1];
        [stickHandler saveStickSettings];
    }
    
    // Update the GUI (this will refresh the function list).
    unsigned skip;
    if (selFunctionIdx < MAX_ROWS_FUNCTIONS - 1)
    {
        skip = 0;
    }
    else
    {
        skip = ((selFunctionIdx - 1) / (MAX_ROWS_FUNCTIONS - 2)) * (MAX_ROWS_FUNCTIONS - 2) + 1;
    }
    
    [self setGuiToStickMapperScreen:skip];
}

updateKeyDefinition:index:

- (void) updateKeyDefinition: (NSString *)  keystring index: (NSUInteger)  index

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                            :(NSString *)keystring index:(NSUInteger)index
{
    NSMutableDictionary *key_def = [[NSMutableDictionary alloc] initWithDictionary:(NSDictionary *)[key_list objectAtIndex:index] copyItems:YES];
    [key_def setObject:keystring forKey:@"key"];
    // auto=turn on shift if the entered key was shifted
 
    if (last_shift && [keystring length] == 1 && ![nav_keys containsObject:[selected_entry objectForKey: KEY_KC_DEFINITION]]) 
    {
        [key_def setObject:[NSNumber numberWithBool:YES] forKey:@"shift"];
    }
    if (!last_shift && [keystring length] == 1)
    {
        [key_def setObject:[NSNumber numberWithBool:NO] forKey:@"shift"];
    }
    last_shift = NO;
    if (index > [key_list count] - 1)
    {
        [key_list insertObject:key_def atIndex:index];
    }
    else 
    {
        [key_list replaceObjectAtIndex:index withObject:key_def];
    }
    [key_def release];
    NSArray *new_array = [self processKeyCode:key_list];
    [key_list release];
    key_list = [[NSMutableArray alloc] initWithArray:new_array copyItems:YES];
    [new_array release];
}

updateMovementFlags

- (void) updateMovementFlags

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    hasMoved = !HPvector_equal(position, lastPosition);
    hasRotated = !quaternion_equal(orientation, lastOrientation);
    lastPosition = position;
    lastOrientation = orientation;
}

updateShiftKeyDefinition:index:

- (void) updateShiftKeyDefinition: (NSString *)  key index: (NSUInteger)  index

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                                 :(NSString *)key index:(NSUInteger)index
{
    NSMutableDictionary *key_def = [[NSMutableDictionary alloc] initWithDictionary:(NSDictionary *)[key_list objectAtIndex:index] copyItems:YES];
    BOOL current = [[key_def objectForKey:key] boolValue];
    BOOL keycode_changed = NO;
    current = !current;
    [key_def setObject:[NSNumber numberWithBool:current] forKey:key];
    if ([key isEqualToString:@"shift"]) 
    {
        // force the key into upper or lower case, to limit invalid key combos as much as possible
        NSString* keycode = [key_def objectForKey:@"key"];
        NSInteger k_int = (OOKeyCode)[keycode integerValue];
        if (k_int > 0)
        {
            NSString* keystring = [self keyCodeDescription:k_int];
            NSString* newstring;
            if ([keystring length] == 1) 
            {
                // try switching the case. for characters that can't be switched (eg 1,2,3,etc), this should do nothing
                if (current) 
                {
                    newstring = [keystring uppercaseString];
                } 
                else 
                {
                    newstring = [keystring lowercaseString];
                }
                if (![newstring isEqualToString:keystring]) 
                {
                    [key_def setObject:newstring forKey:@"key"];
                    keycode_changed = YES;
                }
            }
        }
    }
    if (index > [key_list count] - 1)
    {
        [key_list insertObject:key_def atIndex:index];
    }
    else 
    {
        [key_list replaceObjectAtIndex:index withObject:key_def];
    }
    [key_def release];
    if (keycode_changed) 
    {
        NSArray *new_array = [self processKeyCode:key_list];
        [key_list release];
        key_list = [[NSMutableArray alloc] initWithArray:new_array copyItems:YES];
        [new_array release];
    }
}

updateSystemMemory

- (void) updateSystemMemory

Definition at line 13727 of file PlayerEntity.m.

{
    OOSystemID sys = [self currentSystemID];
    if (sys < 0)
    {
        return;
    }
    NSUInteger memory = 4;
    if (ship_kills >= 6400)
    {
        memory = 32;
    }
    else if (ship_kills >= 256)
    {
        memory = 16;
    }
    else if (ship_kills >= 64)
    {
        memory = 8;
    }
    if ([roleSystemList count] >= memory)
    {
        [roleSystemList removeObjectAtIndex:0];
    }
    [roleSystemList addObject:[NSNumber numberWithInt:sys]];
}

updateTargeting

- (void) updateTargeting

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    STAGE_TRACKING_BEGIN
    
    // check for lost ident target and ensure the ident system is actually scanning
    UPDATE_STAGE(@"checking ident target");
    if (ident_engaged && [self primaryTarget] != nil)
    {
        if (![self isValidTarget:[self primaryTarget]])
        {
            if (!suppressTargetLost)
            {
                [UNIVERSE addMessage:DESC(@"target-lost") forCount:3.0];
                [self playTargetLost];
                [self noteLostTarget];
            }
            else
            {
                suppressTargetLost = NO;
            }
 
            DESTROY(_primaryTarget);
        }
    }
 
    // check each unlaunched missile's target still exists and is in-range
    UPDATE_STAGE(@"checking missile targets");
    if (missile_status != MISSILE_STATUS_SAFE)
    {
        unsigned i;
        for (i = 0; i < max_missiles; i++)
        {
            if ([missile_entity[i] primaryTarget] != nil &&
                    ![self isValidTarget:[missile_entity[i] primaryTarget]])
            {
                [UNIVERSE addMessage:DESC(@"target-lost") forCount:3.0];
                [self playTargetLost];
                [missile_entity[i] removeTarget:nil];
                if (i == activeMissile)
                {
                    [self noteLostTarget];
                    DESTROY(_primaryTarget);
                    missile_status = MISSILE_STATUS_ARMED;
                }
            } else if (i == activeMissile && [missile_entity[i] primaryTarget] == nil) {
                missile_status = MISSILE_STATUS_ARMED;
            }
        }
    }
 
    // if we don't have a primary target, and we're scanning, then check for a new
    // target to lock on to
    UPDATE_STAGE(@"looking for new target");
    if ([self primaryTarget] == nil && 
            (ident_engaged || missile_status != MISSILE_STATUS_SAFE) &&
            ([self status] == STATUS_IN_FLIGHT || [self status] == STATUS_WITCHSPACE_COUNTDOWN))
    {
        Entity *target = [UNIVERSE firstEntityTargetedByPlayer];
        if ([self isValidTarget:target])
        {
            [self addTarget:target];
        }
    }
    
    // If our primary target is a wormhole, check to see if we have additional
    // information
    UPDATE_STAGE(@"checking for additional wormhole information");
    if ([[self primaryTarget] isWormhole])
    {
        WormholeEntity *wh = [self primaryTarget];
        switch ([wh scanInfo])
        {
            case WH_SCANINFO_NONE:
                OOLog(kOOLogInconsistentState, @"%@", @"Internal Error - WH_SCANINFO_NONE reached in [PlayerEntity updateTargeting:]");
                [self dumpState];
                [wh dumpState];
                // Workaround a reported hit of the assert here.  We really
                // should work out how/why this could happen though and fix
                // the underlying cause.
                // - MKW 2011.03.11
                //assert([wh scanInfo] != WH_SCANINFO_NONE);
                [wh setScannedAt:[self clockTimeAdjusted]];
                break;
            case WH_SCANINFO_SCANNED:
                if ([self clockTimeAdjusted] > [wh scanTime] + 2)
                {
                    [wh setScanInfo:WH_SCANINFO_COLLAPSE_TIME];
                    //[UNIVERSE addCommsMessage:[NSString stringWithFormat:DESC(@"wormhole-collapse-time-computed"),
                    //                         [UNIVERSE getSystemName:[wh destination]]] forCount:5.0];
                }
                break;
            case WH_SCANINFO_COLLAPSE_TIME:
                if([self clockTimeAdjusted] > [wh scanTime] + 4)
                {
                    [wh setScanInfo:WH_SCANINFO_ARRIVAL_TIME];
                    [UNIVERSE addCommsMessage:[NSString stringWithFormat:DESC(@"wormhole-arrival-time-computed-@"),
                                               ClockToString([wh estimatedArrivalTime], NO)] forCount:5.0];
                }
                break;
            case WH_SCANINFO_ARRIVAL_TIME:
                if ([self clockTimeAdjusted] > [wh scanTime] + 7)
                {
                    [wh setScanInfo:WH_SCANINFO_DESTINATION];
                    [UNIVERSE addCommsMessage:[NSString stringWithFormat:DESC(@"wormhole-destination-computed-@"),
                                               [UNIVERSE getSystemName:[wh destination]]] forCount:5.0];
                }
                break;
            case WH_SCANINFO_DESTINATION:
                if ([self clockTimeAdjusted] > [wh scanTime] + 10)
                {
                    [wh setScanInfo:WH_SCANINFO_SHIP];
                    // TODO: Extract last ship from wormhole and display its name
                }
                break;
            case WH_SCANINFO_SHIP:
                break;
        }
    }
    
    STAGE_TRACKING_END
}

updateTrumbles:

- (void) updateTrumbles: (OOTimeDelta)  delta_t

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                       :(OOTimeDelta)delta_t
{
    OOTrumble   **trumbles = [self trumbleArray];
    NSUInteger  i;
    
    for (i = [self trumbleCount] ; i > 0; i--)
    {
        OOTrumble* trum = trumbles[i - 1];
        [trum updateTrumble:delta_t];
    }
}

updateWormholes

- (void) updateWormholes

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 9242 of file PlayerEntity.m.

{
    assert(scannedWormholes != nil);
    
    if ([scannedWormholes count] == 0)
        return;
 
    double now = [self clockTimeAdjusted];
 
    NSMutableArray * savedWormholes = [[NSMutableArray alloc] initWithCapacity:[scannedWormholes count]];
    WormholeEntity *wh;
 
    foreach (wh, scannedWormholes)
    {
        // TODO: Start drawing wormhole exit a few seconds before the first
        //       ship is disgorged.
        if ([wh arrivalTime] > now)
        {
            [savedWormholes addObject:wh];
        }
        else if (NSEqualPoints(galaxy_coordinates, [wh destinationCoordinates]))
        {
            [wh disgorgeShips];
            if ([[wh shipsInTransit] count] > 0)
            {
                [savedWormholes addObject:wh];
            }
        }
        // Else wormhole has expired in another system, let it expire
    }
 
    [scannedWormholes release];
    scannedWormholes = savedWormholes;
}

useSpecialCargo:

- (void) useSpecialCargo:

(NSString *)

descriptionString

Provided by category PlayerEntity(Scripting).

Definition at line 954 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)descriptionString
{
    if (scriptTarget != self)  return;
 
    [self removeAllCargo:YES];  
    OOLog(kOOLogNoteUseSpecialCargo, @"Going to useSpecialCargo:'%@'", descriptionString);
    specialCargo = [OOExpand(descriptionString) retain];
}

Referenced by PlayerShipUseSpecialCargo().

Here is the caller graph for this function:

validateAllKeys

- (NSArray *) validateAllKeys

implementation

Provided by category PlayerEntity(KeyMapperInternal).

Definition at line 44 of file PlayerEntityKeyMapper.m.

{
    NSMutableArray *failed = [[NSMutableArray alloc] init];
    NSString *validate = nil;
    NSUInteger i;
 
    for (i = 0; i < [keyFunctions count]; i++)
    {
        NSDictionary *entry = [keyFunctions objectAtIndex:i];
        validate = [self validateKey:[entry objectForKey:KEY_KC_DEFINITION] checkKeys:(NSArray *)[keyconfig2_settings objectForKey:[entry objectForKey:KEY_KC_DEFINITION]]];
        if (validate) 
        {
            [failed addObject:validate];
        }
    }
    return [failed copy];
}

validateCompassTarget

- (void) validateCompassTarget

Definition at line 13727 of file PlayerEntity.m.

{
    OOSunEntity     *the_sun = [UNIVERSE sun];
    OOPlanetEntity  *the_planet = [UNIVERSE planet];
    StationEntity   *the_station = [UNIVERSE station];
    Entity          *the_target = [self primaryTarget];
    Entity <OOBeaconEntity>     *beacon = [self nextBeacon];
    if ([self isInSpace] && the_sun && the_planet       // be in a system
        && ![the_sun goneNova])         // and the system has not been novabombed
    {
        Entity *new_target = nil;
        OOAegisStatus   aegis = [self checkForAegis];
        
        switch ([self compassMode])
        {
            case COMPASS_MODE_INACTIVE:
                break;
            
            case COMPASS_MODE_BASIC:
                if ((aegis == AEGIS_CLOSE_TO_MAIN_PLANET || aegis == AEGIS_IN_DOCKING_RANGE) && the_station)
                {
                    new_target = the_station;
                }
                else
                {
                    new_target = the_planet;
                }
                break;
                
            case COMPASS_MODE_PLANET:
                new_target = the_planet;
                break;
                
            case COMPASS_MODE_STATION:
                new_target = the_station;
                break;
                
            case COMPASS_MODE_SUN:
                new_target = the_sun;
                break;
                
            case COMPASS_MODE_TARGET:
                new_target = the_target;
                break;
                
            case COMPASS_MODE_BEACONS:
                new_target = beacon;
                break;
        }
        
        if (new_target == nil || [new_target status] < STATUS_ACTIVE || [new_target status] == STATUS_IN_HOLD)
        {
            [self setCompassMode:COMPASS_MODE_PLANET];
            new_target = the_planet;
        }
        
        if (EXPECT_NOT(new_target != [self compassTarget]))
        {
            [self setCompassTarget:new_target];
            [self doScriptEvent:OOJSID("compassTargetChanged") withArguments:[NSArray arrayWithObjects:new_target, OOStringFromCompassMode([self compassMode]), nil]];
        }
    }
}

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

validateCustomEquipActivationArray

- (void) validateCustomEquipActivationArray

Definition at line 9242 of file PlayerEntity.m.

{
    int i;
    bool update = NO;
    NSString *equipmentKey;
    if ([customEquipActivation count] == 0) return;
    for (i = [customEquipActivation count] - 1; i >= 0; i--) {
        equipmentKey = [[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPKEY];
        OOEquipmentType *eq = [OOEquipmentType equipmentTypeWithIdentifier:equipmentKey];
        if (!eq) {
            [customEquipActivation removeObjectAtIndex:i];
            [customActivatePressed removeObjectAtIndex:i];
            [customModePressed removeObjectAtIndex:i];
            update = YES;
        }
    }
    if (update) {
        NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
        [defaults setObject:customEquipActivation forKey:KEYCONFIG_CUSTOMEQUIP];
    }
}

validatedMarker:

- (NSDictionary *) validatedMarker:

(NSDictionary *)

marker

Provided by category PlayerEntity(ScriptMethods).

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                  :(NSDictionary *)marker
{
    OOSystemID dest = [marker oo_intForKey:@"system"];
// FIXME: parameters
    if (dest < 0 || dest > kOOMaximumSystemID)
    {
        return nil;
    }
    NSString *group = [marker oo_stringForKey:@"name" defaultValue:MISSION_DEST_LEGACY];
 
    return [[[NSDictionary dictionaryWithObjectsAndKeys:
                                [NSNumber numberWithInt:dest], @"system",
                                group, @"name",
                                [marker oo_stringForKey:@"markerColor" defaultValue:@"redColor"], @"markerColor",
                                [marker oo_stringForKey:@"markerShape" defaultValue:@"MARKER_X"], @"markerShape",
                              [NSNumber numberWithFloat:[marker oo_floatForKey:@"markerScale" defaultValue:1.0]], @"markerScale",
                                nil] retain] autorelease];
 
}

validateKey:checkKeys:

- (NSString *) validateKey:		(NSString*)	key
checkKeys:		(NSArray*)	check_keys

Provided by category PlayerEntity(KeyMapper).

Definition at line 44 of file PlayerEntityKeyMapper.m.

                          :(NSString *)key checkKeys:(NSArray *)check_keys
{
    NSString *result = nil;
    
    // need to group keys into validation groups
    NSArray *gui_keys = [NSArray arrayWithObjects:@"key_gui_arrow_left", @"key_gui_arrow_right", @"key_gui_arrow_up", @"key_gui_arrow_down", @"key_gui_page_up", 
        @"key_gui_page_down", @"key_gui_select", nil];
 
    if ([gui_keys containsObject:key]) 
    {
        result = [self searchArrayForMatch:gui_keys key:key checkKeys:check_keys];
        if (result) return result;
    }
 
    NSArray *debug_keys = [NSArray arrayWithObjects:
        @"key_dump_target_state", @"key_dump_entity_list", @"key_debug_full", @"key_debug_collision", @"key_debug_console_connect", @"key_debug_bounding_boxes", 
        @"key_debug_shaders", @"key_debug_off", nil];
 
    if ([debug_keys containsObject:key]) 
    {
        result = [self searchArrayForMatch:debug_keys key:key checkKeys:check_keys];
        if (result) return result;
    }
 
    NSArray *customview_keys = [NSArray arrayWithObjects:
        @"key_custom_view", @"key_custom_view_zoom_out", @"key_custom_view_zoom_in", @"key_custom_view_roll_left", @"key_custom_view_pan_left", 
        @"key_custom_view_roll_right", @"key_custom_view_pan_right", @"key_custom_view_rotate_up", @"key_custom_view_pan_up", @"key_custom_view_rotate_down", 
        @"key_custom_view_pan_down", @"key_custom_view_rotate_left", @"key_custom_view_rotate_right", nil];
 
    if ([customview_keys containsObject:key]) 
    {
        result = [self searchArrayForMatch:customview_keys key:key checkKeys:check_keys];
        if (result) return result;
    }
 
    NSMutableArray *inflight_keys = [NSMutableArray arrayWithObjects:
        @"key_roll_left", @"key_roll_right", @"key_pitch_forward", @"key_pitch_back", @"key_yaw_left", @"key_yaw_right", @"key_view_forward", @"key_view_aft", 
        @"key_view_port", @"key_view_starboard", @"key_increase_speed", @"key_decrease_speed", @"key_inject_fuel", @"key_fire_lasers", @"key_weapons_online_toggle", 
        @"key_launch_missile", @"key_next_missile", @"key_ecm", @"key_prime_next_equipment", @"key_prime_previous_equipment", @"key_activate_equipment", 
        @"key_mode_equipment", @"key_fastactivate_equipment_a", @"key_fastactivate_equipment_b", @"key_target_incoming_missile", @"key_target_missile", 
        @"key_untarget_missile", @"key_ident_system", @"key_scanner_zoom", @"key_scanner_unzoom", @"key_launch_escapepod", @"key_galactic_hyperspace", 
        @"key_hyperspace", @"key_jumpdrive", @"key_dump_cargo", @"key_rotate_cargo", @"key_autopilot", @"key_autodock", @"key_docking_clearance_request", 
        @"key_snapshot", @"key_cycle_next_mfd", @"key_cycle_previous_mfd", @"key_switch_next_mfd", @"key_switch_previous_mfd", 
        @"key_next_target", @"key_previous_target", @"key_comms_log", @"key_prev_compass_mode", @"key_next_compass_mode", @"key_custom_view", 
#if OO_FOV_INFLIGHT_CONTROL_ENABLED
        @"key_inc_field_of_view", @"key_dec_field_of_view", 
#endif
        @"key_pausebutton", @"key_dump_target_state", nil];
    
    if ([self entryIsCustomEquip:key]) {
        NSUInteger i;
        for (i = 0; i < [customEquipActivation count]; i++)
        {
            [inflight_keys addObject:[NSString stringWithFormat:@"activate_%@", [[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPKEY]]];
            [inflight_keys addObject:[NSString stringWithFormat:@"mode_%@", [[customEquipActivation objectAtIndex:i] oo_stringForKey:CUSTOMEQUIP_EQUIPKEY]]];
        }
    }
 
    if ([inflight_keys containsObject:key]) 
    {
        result = [self searchArrayForMatch:inflight_keys key:key checkKeys:check_keys];
        if (result) return result;
    }
 
    NSArray *docking_keys = [NSArray arrayWithObjects:
        @"key_docking_music", @"key_autopilot", @"key_pausebutton", nil];
 
    if ([docking_keys containsObject:key]) 
    {
        result = [self searchArrayForMatch:docking_keys key:key checkKeys:check_keys];
        if (result) return result;
    }
 
    NSArray *docked_keys = [
        [NSArray arrayWithObjects:@"key_launch_ship", @"key_gui_screen_options", @"key_gui_screen_equipship", @"key_gui_screen_interfaces", @"key_gui_screen_status", 
        @"key_gui_chart_screens", @"key_gui_system_data", @"key_gui_market", nil]
        arrayByAddingObjectsFromArray:gui_keys];
 
    if ([docked_keys containsObject:key])
    {
        result = [self searchArrayForMatch:docked_keys key:key checkKeys:check_keys];
        if (result) return result;
    }
 
    NSArray *paused_keys = [[
        [NSArray arrayWithObjects:@"key_pausebutton", @"key_gui_screen_options", @"key_hud_toggle", @"key_show_fps", @"key_mouse_control_roll", 
        @"key_mouse_control_yaw", nil] 
        arrayByAddingObjectsFromArray:debug_keys]
        arrayByAddingObjectsFromArray:customview_keys];
 
    if ([paused_keys containsObject:key])
    {
        result = [self searchArrayForMatch:paused_keys key:key checkKeys:check_keys];
        if (result) return result;
    }
 
    NSArray *chart_keys = [NSArray arrayWithObjects:
        @"key_advanced_nav_array_next", @"key_advanced_nav_array_previous", @"key_map_home", @"key_map_end", @"key_map_info", 
        @"key_map_zoom_in", @"key_map_zoom_out", @"key_map_next_system", @"key_map_previous_system", @"key_chart_highlight", 
        @"key_launch_ship", @"key_gui_screen_options", @"key_gui_screen_equipship", @"key_gui_screen_interfaces", @"key_gui_screen_status", 
        @"key_gui_chart_screens", @"key_gui_system_data", @"key_gui_market", nil];
 
    if ([chart_keys containsObject:key])
    {
        result = [self searchArrayForMatch:chart_keys key:key checkKeys:check_keys];
        if (result) return result;
    }
 
    NSArray *sysinfo_keys = [NSArray arrayWithObjects:
        @"key_system_home", @"key_system_end", @"key_system_next_system", @"key_system_previous_system", 
        @"key_launch_ship", @"key_gui_screen_options", @"key_gui_screen_equipship", @"key_gui_screen_interfaces", @"key_gui_screen_status", 
        @"key_gui_chart_screens", @"key_gui_system_data", @"key_gui_market", nil];
 
    if ([sysinfo_keys containsObject:key])
    {
        result = [self searchArrayForMatch:sysinfo_keys key:key checkKeys:check_keys];
        if (result) return result;
    }
 
    NSArray *market_keys = [NSArray arrayWithObjects:
        @"key_market_filter_cycle", @"key_market_sorter_cycle", @"key_market_buy_one", @"key_market_sell_one", @"key_market_buy_max", 
        @"key_market_sell_max", @"key_launch_ship", @"key_gui_screen_options", @"key_gui_screen_equipship", @"key_gui_screen_interfaces", @"key_gui_screen_status", 
        @"key_gui_chart_screens", @"key_gui_system_data", @"key_gui_market", @"key_gui_arrow_up", @"key_gui_arrow_down", @"key_gui_page_up", 
        @"key_gui_page_down", @"key_gui_select", nil];
        
    if ([market_keys containsObject:key])
    {
        result = [self searchArrayForMatch:market_keys key:key checkKeys:check_keys];
        if (result) return result;
    }
 
    // if we get here, we should be good
    return nil;
}

validForAddToUniverse

- (BOOL) validForAddToUniverse

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

{
    return YES;
}

viewpointOffset

- (Vector) viewpointOffset

Definition at line 13727 of file PlayerEntity.m.

{
//  if ([UNIVERSE breakPatternHide])
//      return kZeroVector; // center view for break pattern
    // now done by positioning break pattern correctly
 
    switch ([UNIVERSE viewDirection])
    {
        case VIEW_FORWARD:
            return forwardViewOffset;
        case VIEW_AFT:
            return aftViewOffset;
        case VIEW_PORT:
            return portViewOffset;
        case VIEW_STARBOARD:
            return starboardViewOffset;
        /* GILES custom viewpoints */
        case VIEW_CUSTOM:
            return customViewOffset;
        /* -- */
        
        default:
            break;
    }
 
    return kZeroVector;
}

viewpointOffsetAft

- (Vector) viewpointOffsetAft

Definition at line 13727 of file PlayerEntity.m.

{
    return aftViewOffset;
}

viewpointOffsetForward

- (Vector) viewpointOffsetForward

Definition at line 13727 of file PlayerEntity.m.

{
    return forwardViewOffset;
}

viewpointOffsetPort

- (Vector) viewpointOffsetPort

Definition at line 13727 of file PlayerEntity.m.

{
    return portViewOffset;
}

viewpointOffsetStarboard

- (Vector) viewpointOffsetStarboard

Definition at line 13727 of file PlayerEntity.m.

{
    return starboardViewOffset;
}

viewpointPosition

- (HPVector) viewpointPosition

Definition at line 13727 of file PlayerEntity.m.

{
    HPVector        viewpoint = position;
    if (showDemoShips)
    {
        viewpoint = kZeroHPVector;
    }
    Vector      offset = [self viewpointOffset];
    
    // FIXME: this ought to be done with matrix or quaternion functions.
    OOMatrix r = rotMatrix;
    
    viewpoint.x += offset.x * r.m[0][0];    viewpoint.y += offset.x * r.m[1][0];    viewpoint.z += offset.x * r.m[2][0];
    viewpoint.x += offset.y * r.m[0][1];    viewpoint.y += offset.y * r.m[1][1];    viewpoint.z += offset.y * r.m[2][1];
    viewpoint.x += offset.z * r.m[0][2];    viewpoint.y += offset.z * r.m[1][2];    viewpoint.z += offset.z * r.m[2][2];
    
    return viewpoint;
}

warnAboutHostiles

- (void) warnAboutHostiles

Reimplemented from Entity.

Definition at line 13727 of file PlayerEntity.m.

{
    [self playHostileWarning];
}

weaponForFacing:

- (OOWeaponType) weaponForFacing:

(OOWeaponFacing)

facing

Definition at line 13727 of file PlayerEntity.m.

                                :(OOWeaponFacing)facing
{
    switch (facing)
    {
        case WEAPON_FACING_FORWARD:
            return forward_weapon_type;
            
        case WEAPON_FACING_AFT:
            return aft_weapon_type;
            
        case WEAPON_FACING_PORT:
            return port_weapon_type;
            
        case WEAPON_FACING_STARBOARD:
            return starboard_weapon_type;
            
        case WEAPON_FACING_NONE:
            break;
    }
    return nil;
}

weaponsOnline

- (BOOL) weaponsOnline

Definition at line 13727 of file PlayerEntity.m.

{
    return weapons_online;
}

weaponTypeForFacing:strict:

- (OOEquipmentType *) weaponTypeForFacing: (OOWeaponFacing)  facing strict: (BOOL)  strict

implementation

Reimplemented from ShipEntity.

Definition at line 13727 of file PlayerEntity.m.

                                         :(OOWeaponFacing)facing strict:(BOOL)strict
{
    OOWeaponType weaponType = nil;
    
    switch (facing)
    {
        case WEAPON_FACING_FORWARD:
            weaponType = forward_weapon_type;
            break;
            
        case WEAPON_FACING_AFT:
            weaponType = aft_weapon_type;
            break;
            
        case WEAPON_FACING_PORT:
            weaponType = port_weapon_type;
            break;
            
        case WEAPON_FACING_STARBOARD:
            weaponType = starboard_weapon_type;
            break;
            
        case WEAPON_FACING_NONE:
            break;
    }
 
    return weaponType;
}

Referenced by PlayerShipGetProperty().

Here is the caller graph for this function:

weaponViewOffset

- (Vector) weaponViewOffset

Definition at line 9242 of file PlayerEntity.m.

{
    switch (currentWeaponFacing)
    {
        case WEAPON_FACING_FORWARD:
            return forwardViewOffset;
        case WEAPON_FACING_AFT:
            return aftViewOffset;
        case WEAPON_FACING_PORT:
            return portViewOffset;
        case WEAPON_FACING_STARBOARD:
            return starboardViewOffset;
            
        case WEAPON_FACING_NONE:
            // N.b.: this case should never happen.
            return customViewOffset;
    }
    return kZeroVector;
}

witchEnd

- (void) witchEnd

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    [UNIVERSE setSystemTo:system_id];
    galaxy_coordinates = [[UNIVERSE systemManager] getCoordinatesForSystem:system_id inGalaxy:galaxy_number];
 
    [UNIVERSE setUpUniverseFromWitchspace];
    [[UNIVERSE planet] update: 2.34375 * market_rnd];   // from 0..10 minutes
    [[UNIVERSE station] update: 2.34375 * market_rnd];  // from 0..10 minutes
    
    chart_centre_coordinates = galaxy_coordinates;
    target_chart_centre = chart_centre_coordinates;
}

witchJumpChecklist:

- (BOOL) witchJumpChecklist:

(BOOL)

isGalacticJump

Definition at line 13727 of file PlayerEntity.m.

                           :(BOOL)isGalacticJump
{
    // Perform this check only when doing the actual jump
    if ([self status] == STATUS_WITCHSPACE_COUNTDOWN)
    {
        // check nearby masses
        //UPDATE_STAGE(@"checking for mass blockage");
        ShipEntity* blocker = [UNIVERSE entityForUniversalID:[self checkShipsInVicinityForWitchJumpExit]];
        if (blocker)
        {
            [UNIVERSE clearPreviousMessage];
            NSString *blockerName = [blocker name];
            [UNIVERSE addMessage:OOExpandKey(@"witch-blocked", blockerName) forCount:4.5];
            [self playWitchjumpBlocked];
            [self setStatus:STATUS_IN_FLIGHT];
            ShipScriptEventNoCx(self, "playerJumpFailed", OOJSSTR("blocked"));
            return NO;
        }
    }
 
    // For galactic hyperspace jumps we skip the remaining checks
    if (isGalacticJump)
    {
        return YES;
    }
 
    // Check we're not jumping into the current system
    if (![UNIVERSE inInterstellarSpace] && system_id == target_system_id)
    {
        //dont allow player to hyperspace to current location.
        //Note interstellar space will have a system_seed place we came from
        [UNIVERSE clearPreviousMessage];
        [UNIVERSE addMessage:OOExpandKey(@"witch-no-target") forCount: 4.5];
        if ([self status] == STATUS_WITCHSPACE_COUNTDOWN)
        {
            [self playWitchjumpInsufficientFuel];
            [self setStatus:STATUS_IN_FLIGHT];
            ShipScriptEventNoCx(self, "playerJumpFailed", OOJSSTR("no target"));
        }
        else  [self playHyperspaceNoTarget];
 
        return NO;
    }
 
    // check max distance permitted
    if ([self hyperspaceJumpDistance] > [self maxHyperspaceDistance])
    {
        [UNIVERSE clearPreviousMessage];
        [UNIVERSE addMessage:DESC(@"witch-too-far") forCount: 4.5];
        if ([self status] == STATUS_WITCHSPACE_COUNTDOWN)
        {
            [self playWitchjumpDistanceTooGreat];
            [self setStatus:STATUS_IN_FLIGHT];
            ShipScriptEventNoCx(self, "playerJumpFailed", OOJSSTR("too far"));
        }
        else  [self playHyperspaceDistanceTooGreat];
        
        return NO;
    }
 
    // check fuel level
    if (![self hasSufficientFuelForJump])
    {
        [UNIVERSE clearPreviousMessage];
        [UNIVERSE addMessage:DESC(@"witch-no-fuel") forCount: 4.5];
        if ([self status] == STATUS_WITCHSPACE_COUNTDOWN)
        {
            [self playWitchjumpInsufficientFuel];
            [self setStatus:STATUS_IN_FLIGHT];
            ShipScriptEventNoCx(self, "playerJumpFailed", OOJSSTR("insufficient fuel"));
        }
        else  [self playHyperspaceNoFuel];
        
        return NO;
    }
 
    // All checks passed
    return YES;
}

Referenced by PlayerShipBeginGalacticHyperspaceCountdown().

Here is the caller graph for this function:

witchJumpTo:misjump:

- (void) witchJumpTo: (OOSystemID)  sTo misjump: (BOOL)  misjump

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

                    :(OOSystemID)sTo misjump:(BOOL)misjump
{
    [self witchStart];
    if (info_system_id == system_id)
    {
        [self setInfoSystemID: sTo moveChart: YES];
    }
    //wear and tear on all jumps (inc misjumps, failures, and wormholes)
    if (2 * market_rnd < ship_trade_in_factor)
    {
        // every eight jumps or so drop the price down towards 75%
        [self adjustTradeInFactorBy:-(1 + (market_rnd & 3))];
    }
    
    // set clock after "playerWillEnterWitchspace" and before  removeAllEntitiesExceptPlayer, to allow escorts time to follow their mother. 
    NSPoint destCoords = PointFromString([[UNIVERSE systemManager] getProperty:@"coordinates" forSystem:sTo inGalaxy:galaxy_number]);
    double distance = distanceBetweenPlanetPositions(destCoords.x,destCoords.y,galaxy_coordinates.x,galaxy_coordinates.y);
    
    // if we just escaped a system gone nova, make sure all nova parameters are reset
    OOSunEntity *theSun = [UNIVERSE sun];
    if (theSun && [theSun goneNova])
    {
        [theSun resetNova];
    }
    
    [UNIVERSE removeAllEntitiesExceptPlayer];
    if (!misjump)
    {
        ship_clock_adjust += distance * distance * 3600.0;
        [self setSystemID:sTo];
        [self setBounty:(legalStatus/2) withReason:kOOLegalStatusReasonNewSystem];  // 'another day, another system'
        [self witchEnd];
        if (market_rnd < 8) [self erodeReputation];     // every 32 systems or so, drop back towards 'unknown'
    }
    else
    {
        // Misjump: move halfway there!
        // misjumps do not change legal status.
        if (randf() < 0.1) [self erodeReputation];      // once every 10 misjumps - should be much rarer than successful jumps!
 
        [wormhole setMisjump]; 
        // just in case, but this has usually been set already
 
        // and now the wormhole has travel time and coordinates calculated
        // so rather than duplicate the calculation we'll just ask it...
        NSPoint dest = [wormhole destinationCoordinates];
        galaxy_coordinates.x = dest.x;
        galaxy_coordinates.y = dest.y;
 
        ship_clock_adjust += [wormhole travelTime];
 
        [self playWitchjumpMisjump];
        [UNIVERSE setUpUniverseFromMisjump];
    }
}

witchStart

- (void) witchStart

implementation

Provided by category PlayerEntity(OOPrivate).

Definition at line 13727 of file PlayerEntity.m.

{
    // chances of entering witchspace with autopilot on are very low, but as Berlios bug #18307 has shown us, entirely possible
    // so in such cases we need to ensure that at least the docking music stops playing
    if (autopilot_engaged)  [self disengageAutopilot];
    
    if (![hud nonlinearScanner])
    {
        [hud setScannerZoom: 1.0];
    }
    [self safeAllMissiles];
    
    OOViewID    previousViewDirection = [UNIVERSE viewDirection];
    [UNIVERSE setViewDirection:VIEW_FORWARD];
    [self noteSwitchToView:VIEW_FORWARD fromView:previousViewDirection]; // notifies scripts of the switch
    
    currentWeaponFacing = WEAPON_FACING_FORWARD;
    [self currentWeaponStats];
 
    [self transitionToAegisNone];
    suppressAegisMessages=YES;
    hyperspeed_engaged = NO;
    
    if ([self primaryTarget] != nil)
    {
        [self noteLostTarget];  // losing target? Fire lost target event!
        DESTROY(_primaryTarget);
    }
    
    scanner_zoom_rate = 0.0f;
    [UNIVERSE setDisplayText:NO];
    
    if ( ![self wormhole] && !galactic_witchjump)   // galactic hyperspace does not generate a wormhole
    {
        OOLog(kOOLogInconsistentState, @"%@", @"Internal Error : Player entering witchspace with no wormhole.");
    }
    [UNIVERSE allShipsDoScriptEvent:OOJSID("playerWillEnterWitchspace") andReactToAIMessage:@"PLAYER WITCHSPACE"];
    
    // set the new market seed now!
    // reseeding the RNG should be completely unnecessary here
//  ranrot_srand((uint32_t)[[NSDate date] timeIntervalSince1970]);  // seed randomiser by time
    market_rnd = ranrot_rand() & 255;                       // random factor for market values is reset
}

worldScriptNames

- (NSArray *) worldScriptNames

Definition at line 9242 of file PlayerEntity.m.

{
    return [worldScripts allKeys];
}

worldScriptsByName

- (NSDictionary *) worldScriptsByName

Definition at line 9242 of file PlayerEntity.m.

{
    return [[worldScripts copy] autorelease];
}

Referenced by WorldScriptsGetProperty().

Here is the caller graph for this function:

wormhole

- (WormholeEntity *) wormhole

writePlayerToPath:

- (void) writePlayerToPath: (NSString *)  path

implementation

Provided by category PlayerEntity(OOLoadSavePrivate).

Definition at line 1420 of file PlayerEntityLoadSave.m.

                          :(NSString *)path
{
    NSString        *errDesc = nil;
    NSDictionary    *dict = nil;
    BOOL            didSave = NO;
    [[UNIVERSE gameView] resetTypedString];
    
    if (!path)
    {
        OOLog(@"save.failed", @"***** SAVE ERROR: %s called with nil path.", __PRETTY_FUNCTION__);
        return;
    }
    
    dict = [self commanderDataDictionary];
    if (dict == nil)  errDesc = @"could not construct commander data dictionary.";
    else  didSave = [dict writeOOXMLToFile:path atomically:YES errorDescription:&errDesc];
    if (didSave)
    {
        [UNIVERSE clearPreviousMessage];    // allow this to be given time and again
        [UNIVERSE addMessage:DESC(@"game-saved") forCount:2];
        [save_path autorelease];
        save_path = [path copy];
        [[UNIVERSE gameController] setPlayerFileToLoad:save_path];
        [[UNIVERSE gameController] setPlayerFileDirectory:save_path];
        // no duplicated autosave immediately after a save.
        [UNIVERSE setAutoSaveNow:NO];
    }
    else
    {
        OOLog(@"save.failed", @"***** SAVE ERROR: %@", errDesc);
        [NSException raise:@"OoliteException"
                    format:@"Attempt to save game to file '%@' failed: %@", path, errDesc];
    }
    [[UNIVERSE gameView] suppressKeysUntilKeyUp];
    [self setGuiToStatusScreen];
}

Member Data Documentation

_commanderName

- (NSString*) _commanderName

private

Definition at line 514 of file PlayerEntity.h.

_customViewIndex

- (NSUInteger) _customViewIndex

private

Definition at line 798 of file PlayerEntity.h.

_customViews

- (NSArray*) _customViews

private

Definition at line 797 of file PlayerEntity.h.

_dockedStation

- (OOWeakReference*) _dockedStation

private

Definition at line 457 of file PlayerEntity.h.

_dockTarget

- (OOUniversalID) _dockTarget

private

Definition at line 524 of file PlayerEntity.h.

_equipScreenBackgroundDescriptor

- (NSDictionary*) _equipScreenBackgroundDescriptor

private

Definition at line 400 of file PlayerEntity.h.

_fastEquipmentA

- (NSString*) _fastEquipmentA

private

Definition at line 490 of file PlayerEntity.h.

_fastEquipmentB

- (NSString*) _fastEquipmentB

private

Definition at line 491 of file PlayerEntity.h.

_jumpCause

- (NSString*) _jumpCause

private

Definition at line 511 of file PlayerEntity.h.

_lastsaveName

- (NSString*) _lastsaveName

private

Definition at line 515 of file PlayerEntity.h.

_missionAllowInterrupt

- (BOOL) _missionAllowInterrupt

private

Definition at line 387 of file PlayerEntity.h.

_missionBackgroundDescriptor

- (NSDictionary*) _missionBackgroundDescriptor

private

Definition at line 398 of file PlayerEntity.h.

_missionBackgroundSpecial

- (OOGUIBackgroundSpecial) _missionBackgroundSpecial

private

Definition at line 399 of file PlayerEntity.h.

_missionExitScreen

- (OOGUIScreenID) _missionExitScreen

private

Definition at line 389 of file PlayerEntity.h.

_missionOverlayDescriptor

- (NSDictionary*) _missionOverlayDescriptor

private

Definition at line 397 of file PlayerEntity.h.

_missionScreenID

- (NSString*) _missionScreenID

private

Definition at line 401 of file PlayerEntity.h.

_missionTextEntry

- (BOOL) _missionTextEntry

private

Definition at line 388 of file PlayerEntity.h.

_missionTitle

- (NSString*) _missionTitle

private

Definition at line 382 of file PlayerEntity.h.

_missionWithCallback

- (BOOL) _missionWithCallback

private

Definition at line 386 of file PlayerEntity.h.

_sysInfoLight

- (Vector) _sysInfoLight

private

Definition at line 708 of file PlayerEntity.h.

_trumbleAppetiteAccumulator

- (float) _trumbleAppetiteAccumulator

private

Definition at line 713 of file PlayerEntity.h.

activeMFD

- (NSUInteger) activeMFD

private

Definition at line 467 of file PlayerEntity.h.

activeMissile

- (NSUInteger) activeMissile

private

Definition at line 488 of file PlayerEntity.h.

aft_shield

- (GLfloat) aft_shield

private

Definition at line 473 of file PlayerEntity.h.

aft_shield_recharge_rate

- (GLfloat) aft_shield_recharge_rate

private

Definition at line 474 of file PlayerEntity.h.

aft_shot_time

- (OOTimeDelta) aft_shot_time

private

Definition at line 475 of file PlayerEntity.h.

afterburner_engaged

- (unsigned) afterburner_engaged

private

Definition at line 743 of file PlayerEntity.h.

afterburnerSoundLooping

- (unsigned) afterburnerSoundLooping

private

Definition at line 744 of file PlayerEntity.h.

aftViewOffset

- (Vector) aftViewOffset

private

Definition at line 707 of file PlayerEntity.h.

alertCondition

- (OOAlertCondition) alertCondition

private

Definition at line 484 of file PlayerEntity.h.

alertFlags

- (int) alertFlags

private

Definition at line 483 of file PlayerEntity.h.

ANA_mode

- (OORouteType) ANA_mode

private

Definition at line 508 of file PlayerEntity.h.

autopilot_engaged

- (unsigned) autopilot_engaged

private

Definition at line 741 of file PlayerEntity.h.

bomb_detonated

- (unsigned) bomb_detonated

private

Definition at line 740 of file PlayerEntity.h.

cdrDetailArray

- (NSMutableArray*) cdrDetailArray

private

Definition at line 447 of file PlayerEntity.h.

chart_centre_coordinates

- (NSPoint) chart_centre_coordinates

private

Definition at line 497 of file PlayerEntity.h.

chart_focus_coordinates

- (NSPoint) chart_focus_coordinates

private

Definition at line 496 of file PlayerEntity.h.

chart_zoom

- (OOScalar) chart_zoom

private

Definition at line 504 of file PlayerEntity.h.

chosen_weapon_facing

- (OOWeaponFacing) chosen_weapon_facing

private

Definition at line 477 of file PlayerEntity.h.

commanderNameString

- (NSString*) commanderNameString

private

Definition at line 446 of file PlayerEntity.h.

commLog

- (NSMutableArray *) commLog

private

Definition at line 393 of file PlayerEntity.h.

commodityScripts

- (NSMutableDictionary*) commodityScripts

private

Definition at line 379 of file PlayerEntity.h.

compassMode

- (OOCompassMode) compassMode

private

Definition at line 530 of file PlayerEntity.h.

Referenced by PlayerShipGetProperty().

compassTarget

- (Entity *) compassTarget

private

Definition at line 531 of file PlayerEntity.h.

Referenced by PlayerShipGetProperty(), and PlayerShipSetProperty().

contract_record

- (NSMutableDictionary*) contract_record

private

Definition at line 415 of file PlayerEntity.h.

contracts

- (NSMutableArray*) contracts

private

Definition at line 414 of file PlayerEntity.h.

credits

- (OOCreditsQuantity) credits

private

Definition at line 518 of file PlayerEntity.h.

current_cargo

- (OOCargoQuantity) current_cargo

private

Definition at line 493 of file PlayerEntity.h.

currentPage

- (int) currentPage

private

Definition at line 448 of file PlayerEntity.h.

cursor_coordinates

- (NSPoint) cursor_coordinates

private

Definition at line 495 of file PlayerEntity.h.

custom_chart_centre_coordinates

- (NSPoint) custom_chart_centre_coordinates

private

Definition at line 498 of file PlayerEntity.h.

custom_chart_zoom

- (OOScalar) custom_chart_zoom

private

Definition at line 505 of file PlayerEntity.h.

customActivatePressed

- (NSMutableArray*) customActivatePressed

private

Definition at line 694 of file PlayerEntity.h.

customDialSettings

- (NSMutableDictionary*) customDialSettings

private

Definition at line 468 of file PlayerEntity.h.

customEquipActivation

- (NSMutableArray*) customEquipActivation

private

Definition at line 693 of file PlayerEntity.h.

customModePressed

- (NSMutableArray*) customModePressed

private

Definition at line 695 of file PlayerEntity.h.

customViewDescription

- (NSString *) customViewDescription

private

Definition at line 727 of file PlayerEntity.h.

customViewForwardVector

- (Vector) customViewForwardVector

private

Definition at line 726 of file PlayerEntity.h.

Referenced by HeadUpDisplay::hudRotateViewpointForVirtualDepth.

customViewMatrix

- (OOMatrix) customViewMatrix

private

Definition at line 725 of file PlayerEntity.h.

customViewOffset

- (Vector) customViewOffset

private

Definition at line 726 of file PlayerEntity.h.

customViewQuaternion

- (Quaternion) customViewQuaternion

private

Definition at line 724 of file PlayerEntity.h.

customViewRightVector

- (Vector) customViewRightVector

private

Definition at line 726 of file PlayerEntity.h.

customViewRotationCenter

- (Vector) customViewRotationCenter

private

Definition at line 726 of file PlayerEntity.h.

customViewUpVector

- (Vector) customViewUpVector

private

Definition at line 726 of file PlayerEntity.h.

Referenced by HeadUpDisplay::hudRotateViewpointForVirtualDepth.

demoShip

- (ShipEntity*) demoShip

private

Definition at line 805 of file PlayerEntity.h.

dockingClearanceStatus

- (OODockingClearanceStatus) dockingClearanceStatus

private

Definition at line 800 of file PlayerEntity.h.

dockingReport

- (NSMutableString*) dockingReport

private

Definition at line 731 of file PlayerEntity.h.

ecm_in_operation

- (unsigned) ecm_in_operation

private

Definition at line 754 of file PlayerEntity.h.

ecm_start_time

- (double) ecm_start_time

private

Definition at line 479 of file PlayerEntity.h.

eqScripts

- (NSMutableArray*) eqScripts

private

Definition at line 395 of file PlayerEntity.h.

escape_pod_rescue_time

- (double) escape_pod_rescue_time

private

Definition at line 433 of file PlayerEntity.h.

extraGuiScreenKeys

- (NSMutableDictionary*) extraGuiScreenKeys

private

Definition at line 700 of file PlayerEntity.h.

extraMissionKeys

- (NSDictionary*) extraMissionKeys

private

Definition at line 698 of file PlayerEntity.h.

fieldOfView

- (double) fieldOfView

private

Definition at line 811 of file PlayerEntity.h.

finished

- (unsigned) finished

private

Definition at line 739 of file PlayerEntity.h.

fleeing_status

- (OOPlayerFleeingStatus) fleeing_status

private

Definition at line 486 of file PlayerEntity.h.

forward_shield

- (GLfloat) forward_shield

private

Definition at line 473 of file PlayerEntity.h.

forward_shield_recharge_rate

- (GLfloat) forward_shield_recharge_rate

private

Definition at line 474 of file PlayerEntity.h.

forward_shot_time

- (OOTimeDelta) forward_shot_time

private

Definition at line 475 of file PlayerEntity.h.

forwardViewOffset

- (Vector) forwardViewOffset

private

Definition at line 707 of file PlayerEntity.h.

found_equipment

- (BOOL) found_equipment

private

Definition at line 403 of file PlayerEntity.h.

found_system_id

- (OOSystemID) found_system_id

private

Definition at line 374 of file PlayerEntity.h.

fps_check_time

- (double) fps_check_time

private

Definition at line 435 of file PlayerEntity.h.

fps_counter

- (int) fps_counter

private

Definition at line 436 of file PlayerEntity.h.

fuel_leak_rate

- (GLfloat) fuel_leak_rate

private

Definition at line 533 of file PlayerEntity.h.

galactic_witchjump

- (unsigned) galactic_witchjump

private

Definition at line 752 of file PlayerEntity.h.

galacticHyperspaceBehaviour

- (OOGalacticHyperspaceBehaviour) galacticHyperspaceBehaviour

private

Definition at line 792 of file PlayerEntity.h.

galacticHyperspaceFixedCoords

- (NSPoint) galacticHyperspaceFixedCoords

private

Definition at line 793 of file PlayerEntity.h.

galaxy_coordinates

- (NSPoint) galaxy_coordinates

private

Definition at line 516 of file PlayerEntity.h.

Referenced by MissionRunScreen().

galaxy_number

- (OOGalaxyID) galaxy_number

private

Provided by category PlayerEntity(Scripting).

Definition at line 519 of file PlayerEntity.h.

game_over

- (unsigned) game_over

private

Definition at line 738 of file PlayerEntity.h.

gui_screen

- (OOGUIScreenID) gui_screen

private

Definition at line 482 of file PlayerEntity.h.

hud

- (HeadUpDisplay *) hud

private

Definition at line 464 of file PlayerEntity.h.

Referenced by PlayerShipGetProperty(), PlayerShipHideHUDSelector(), PlayerShipSetProperty(), and PlayerShipShowHUDSelector().

hyperspeed_engaged

- (unsigned) hyperspeed_engaged

private

Definition at line 746 of file PlayerEntity.h.

hyperspeed_locked

- (unsigned) hyperspeed_locked

private

Definition at line 748 of file PlayerEntity.h.

hyperspeedFactor

- (GLfloat) hyperspeedFactor

private

Definition at line 536 of file PlayerEntity.h.

ident_engaged

- (unsigned) ident_engaged

private

Definition at line 750 of file PlayerEntity.h.

info_system_id

- (OOSystemID) info_system_id

private

Definition at line 369 of file PlayerEntity.h.

isSpeechOn

- (OOSpeechSettings) isSpeechOn

private

Definition at line 780 of file PlayerEntity.h.

kbdLayouts

- (NSArray*) kbdLayouts

private

Definition at line 787 of file PlayerEntity.h.

keyboardPitchOverride

- (unsigned) keyboardPitchOverride

private

Definition at line 766 of file PlayerEntity.h.

keyboardRollOverride

- (unsigned) keyboardRollOverride

private

Definition at line 765 of file PlayerEntity.h.

keyboardYawOverride

- (unsigned) keyboardYawOverride

private

Definition at line 767 of file PlayerEntity.h.

keyCodeLookups

- (NSDictionary*) keyCodeLookups

private

Definition at line 541 of file PlayerEntity.h.

keyconfig2_settings

- (NSDictionary*) keyconfig2_settings

private

Definition at line 540 of file PlayerEntity.h.

keyFunctions

- (NSArray*) keyFunctions

private

Definition at line 786 of file PlayerEntity.h.

keyMod1Text

- (NSString*) keyMod1Text

private

Definition at line 789 of file PlayerEntity.h.

keyMod2Text

- (NSString*) keyMod2Text

private

Definition at line 790 of file PlayerEntity.h.

keyShiftText

- (NSString*) keyShiftText

private

Definition at line 788 of file PlayerEntity.h.

last_ecm_time

- (double) last_ecm_time

private

Definition at line 480 of file PlayerEntity.h.

last_fps_check_time

- (double) last_fps_check_time

private

Definition at line 437 of file PlayerEntity.h.

lastScriptAlertCondition

- (OOAlertCondition) lastScriptAlertCondition

private

Definition at line 485 of file PlayerEntity.h.

lastShot

- (NSArray*) lastShot

private

Definition at line 806 of file PlayerEntity.h.

lastTextKey

- (NSString*) lastTextKey

private

Definition at line 428 of file PlayerEntity.h.

launchingMissile

- (unsigned) launchingMissile

private

Definition at line 772 of file PlayerEntity.h.

launchRoll

- (GLfloat) launchRoll

private

Definition at line 471 of file PlayerEntity.h.

legalStatus

- (int) legalStatus

private

Definition at line 526 of file PlayerEntity.h.

localVariables

- (NSMutableDictionary*) localVariables

private

Definition at line 381 of file PlayerEntity.h.

longRangeChartMode

- (OOLongRangeChartMode) longRangeChartMode

private

Definition at line 795 of file PlayerEntity.h.

Referenced by PlayerShipSetProperty().

market_rnd

- (int) market_rnd

private

Definition at line 527 of file PlayerEntity.h.

marketFilterMode

- (OOMarketFilterMode) marketFilterMode

private

Definition at line 454 of file PlayerEntity.h.

marketOffset

- (NSInteger) marketOffset

private

Definition at line 452 of file PlayerEntity.h.

marketSelectedCommodity

- (OOCommodityType) marketSelectedCommodity

private

Definition at line 453 of file PlayerEntity.h.

marketSorterMode

- (OOMarketSorterMode) marketSorterMode

private

Definition at line 455 of file PlayerEntity.h.

massLockable

- (BOOL) massLockable

private

Definition at line 775 of file PlayerEntity.h.

max_aft_shield

- (GLfloat) max_aft_shield

private

Definition at line 474 of file PlayerEntity.h.

max_forward_shield

- (GLfloat) max_forward_shield

private

Definition at line 474 of file PlayerEntity.h.

max_passengers

- (unsigned) max_passengers

private

Definition at line 407 of file PlayerEntity.h.

maxFieldOfView

- (double) maxFieldOfView

private

Definition at line 810 of file PlayerEntity.h.

missile_entity

- (ShipEntity* missile_entity[PLAYER_MAX_MISSILES])

private

Definition at line 523 of file PlayerEntity.h.

missile_status

- (OOMissileStatus) missile_status

private

Definition at line 487 of file PlayerEntity.h.

mission_variables

- (NSMutableDictionary*) mission_variables

private

Definition at line 380 of file PlayerEntity.h.

missionChoice

- (NSString*) missionChoice

private

Definition at line 384 of file PlayerEntity.h.

missionDestinations

- (NSMutableDictionary*) missionDestinations

private

Definition at line 419 of file PlayerEntity.h.

missionKeyPress

- (NSString*) missionKeyPress

private

Definition at line 385 of file PlayerEntity.h.

missionTextRow

- (NSInteger) missionTextRow

private

Definition at line 383 of file PlayerEntity.h.

mouse_control_on

- (unsigned) mouse_control_on

private

Definition at line 763 of file PlayerEntity.h.

multiFunctionDisplaySettings

- (NSMutableArray*) multiFunctionDisplaySettings

private

Definition at line 466 of file PlayerEntity.h.

multiFunctionDisplayText

- (NSMutableDictionary*) multiFunctionDisplayText

private

Definition at line 465 of file PlayerEntity.h.

n_key_activate_equipment

- (NSArray*) n_key_activate_equipment

private

Definition at line 583 of file PlayerEntity.h.

n_key_advanced_nav_array_next

- (NSArray*) n_key_advanced_nav_array_next

private

Definition at line 611 of file PlayerEntity.h.

n_key_advanced_nav_array_previous

- (NSArray*) n_key_advanced_nav_array_previous

private

Definition at line 612 of file PlayerEntity.h.

n_key_autodock

- (NSArray*) n_key_autodock

private

Definition at line 606 of file PlayerEntity.h.

n_key_autopilot

- (NSArray*) n_key_autopilot

private

Definition at line 605 of file PlayerEntity.h.

n_key_bloom_toggle

- (NSArray*) n_key_bloom_toggle

private

Definition at line 630 of file PlayerEntity.h.

n_key_chart_highlight

- (NSArray*) n_key_chart_highlight

private

Definition at line 639 of file PlayerEntity.h.

n_key_comms_log

- (NSArray*) n_key_comms_log

private

Definition at line 635 of file PlayerEntity.h.

n_key_custom_view

- (NSArray*) n_key_custom_view

private

Definition at line 650 of file PlayerEntity.h.

n_key_custom_view_pan_down

- (NSArray*) n_key_custom_view_pan_down

private

Definition at line 660 of file PlayerEntity.h.

n_key_custom_view_pan_left

- (NSArray*) n_key_custom_view_pan_left

private

Definition at line 654 of file PlayerEntity.h.

n_key_custom_view_pan_right

- (NSArray*) n_key_custom_view_pan_right

private

Definition at line 656 of file PlayerEntity.h.

n_key_custom_view_pan_up

- (NSArray*) n_key_custom_view_pan_up

private

Definition at line 658 of file PlayerEntity.h.

n_key_custom_view_roll_left

- (NSArray*) n_key_custom_view_roll_left

private

Definition at line 653 of file PlayerEntity.h.

n_key_custom_view_roll_right

- (NSArray*) n_key_custom_view_roll_right

private

Definition at line 655 of file PlayerEntity.h.

n_key_custom_view_rotate_down

- (NSArray*) n_key_custom_view_rotate_down

private

Definition at line 659 of file PlayerEntity.h.

n_key_custom_view_rotate_left

- (NSArray*) n_key_custom_view_rotate_left

private

Definition at line 661 of file PlayerEntity.h.

n_key_custom_view_rotate_right

- (NSArray*) n_key_custom_view_rotate_right

private

Definition at line 662 of file PlayerEntity.h.

n_key_custom_view_rotate_up

- (NSArray*) n_key_custom_view_rotate_up

private

Definition at line 657 of file PlayerEntity.h.

n_key_custom_view_zoom_in

- (NSArray*) n_key_custom_view_zoom_in

private

Definition at line 652 of file PlayerEntity.h.

n_key_custom_view_zoom_out

- (NSArray*) n_key_custom_view_zoom_out

private

Definition at line 651 of file PlayerEntity.h.

n_key_cycle_next_mfd

- (NSArray*) n_key_cycle_next_mfd

private

Definition at line 667 of file PlayerEntity.h.

n_key_cycle_previous_mfd

- (NSArray*) n_key_cycle_previous_mfd

private

Definition at line 668 of file PlayerEntity.h.

n_key_debug_bounding_boxes

- (NSArray*) n_key_debug_bounding_boxes

private

Definition at line 687 of file PlayerEntity.h.

n_key_debug_collision

- (NSArray*) n_key_debug_collision

private

Definition at line 685 of file PlayerEntity.h.

n_key_debug_console_connect

- (NSArray*) n_key_debug_console_connect

private

Definition at line 686 of file PlayerEntity.h.

n_key_debug_full

- (NSArray*) n_key_debug_full

private

Definition at line 684 of file PlayerEntity.h.

n_key_debug_off

- (NSArray*) n_key_debug_off

private

Definition at line 689 of file PlayerEntity.h.

n_key_debug_shaders

- (NSArray*) n_key_debug_shaders

private

Definition at line 688 of file PlayerEntity.h.

n_key_decrease_speed

- (NSArray*) n_key_decrease_speed

private

Definition at line 573 of file PlayerEntity.h.

n_key_docking_clearance_request

- (NSArray*) n_key_docking_clearance_request

private

Definition at line 664 of file PlayerEntity.h.

n_key_docking_music

- (NSArray*) n_key_docking_music

private

Definition at line 609 of file PlayerEntity.h.

n_key_dump_cargo

- (NSArray*) n_key_dump_cargo

private

Definition at line 602 of file PlayerEntity.h.

n_key_dump_entity_list

- (NSArray*) n_key_dump_entity_list

private

Definition at line 683 of file PlayerEntity.h.

n_key_dump_target_state

- (NSArray*) n_key_dump_target_state

private

Definition at line 682 of file PlayerEntity.h.

n_key_ecm

- (NSArray*) n_key_ecm

private

Definition at line 579 of file PlayerEntity.h.

n_key_fastactivate_equipment_a

- (NSArray*) n_key_fastactivate_equipment_a

private

Definition at line 585 of file PlayerEntity.h.

n_key_fastactivate_equipment_b

- (NSArray*) n_key_fastactivate_equipment_b

private

Definition at line 586 of file PlayerEntity.h.

n_key_fire_lasers

- (NSArray*) n_key_fire_lasers

private

Definition at line 576 of file PlayerEntity.h.

n_key_galactic_hyperspace

- (NSArray*) n_key_galactic_hyperspace

private

Definition at line 598 of file PlayerEntity.h.

n_key_gui_arrow_down

- (NSArray*) n_key_gui_arrow_down

private

Definition at line 567 of file PlayerEntity.h.

n_key_gui_arrow_left

- (NSArray*) n_key_gui_arrow_left

private

Definition at line 564 of file PlayerEntity.h.

n_key_gui_arrow_right

- (NSArray*) n_key_gui_arrow_right

private

Definition at line 565 of file PlayerEntity.h.

n_key_gui_arrow_up

- (NSArray*) n_key_gui_arrow_up

private

Definition at line 566 of file PlayerEntity.h.

n_key_gui_chart_screens

- (NSArray*) n_key_gui_chart_screens

private

Definition at line 560 of file PlayerEntity.h.

n_key_gui_market

- (NSArray*) n_key_gui_market

private

Definition at line 562 of file PlayerEntity.h.

n_key_gui_page_down

- (NSArray*) n_key_gui_page_down

private

Definition at line 569 of file PlayerEntity.h.

n_key_gui_page_up

- (NSArray*) n_key_gui_page_up

private

Definition at line 568 of file PlayerEntity.h.

n_key_gui_screen_equipship

- (NSArray*) n_key_gui_screen_equipship

private

Definition at line 557 of file PlayerEntity.h.

n_key_gui_screen_interfaces

- (NSArray*) n_key_gui_screen_interfaces

private

Definition at line 558 of file PlayerEntity.h.

n_key_gui_screen_options

- (NSArray*) n_key_gui_screen_options

private

Definition at line 556 of file PlayerEntity.h.

n_key_gui_screen_status

- (NSArray*) n_key_gui_screen_status

private

Definition at line 559 of file PlayerEntity.h.

n_key_gui_select

- (NSArray*) n_key_gui_select

private

Definition at line 570 of file PlayerEntity.h.

n_key_gui_system_data

- (NSArray*) n_key_gui_system_data

private

Definition at line 561 of file PlayerEntity.h.

n_key_hud_toggle

- (NSArray*) n_key_hud_toggle

private

Definition at line 633 of file PlayerEntity.h.

n_key_hyperspace

- (NSArray*) n_key_hyperspace

private

Definition at line 599 of file PlayerEntity.h.

n_key_ident_system

- (NSArray*) n_key_ident_system

private

Definition at line 591 of file PlayerEntity.h.

n_key_increase_speed

- (NSArray*) n_key_increase_speed

private

Definition at line 572 of file PlayerEntity.h.

n_key_info_next_system

- (NSArray*) n_key_info_next_system

private

Definition at line 613 of file PlayerEntity.h.

n_key_info_previous_system

- (NSArray*) n_key_info_previous_system

private

Definition at line 614 of file PlayerEntity.h.

n_key_inject_fuel

- (NSArray*) n_key_inject_fuel

private

Definition at line 574 of file PlayerEntity.h.

n_key_jumpdrive

- (NSArray*) n_key_jumpdrive

private

Definition at line 600 of file PlayerEntity.h.

n_key_launch_escapepod

- (NSArray*) n_key_launch_escapepod

private

Definition at line 596 of file PlayerEntity.h.

n_key_launch_missile

- (NSArray*) n_key_launch_missile

private

Definition at line 577 of file PlayerEntity.h.

n_key_launch_ship

- (NSArray*) n_key_launch_ship

private

Definition at line 555 of file PlayerEntity.h.

n_key_map_end

- (NSArray*) n_key_map_end

private

Definition at line 616 of file PlayerEntity.h.

n_key_map_home

- (NSArray*) n_key_map_home

private

Definition at line 615 of file PlayerEntity.h.

n_key_map_info

- (NSArray*) n_key_map_info

private

Definition at line 619 of file PlayerEntity.h.

n_key_map_next_system

- (NSArray*) n_key_map_next_system

private

Definition at line 617 of file PlayerEntity.h.

n_key_map_previous_system

- (NSArray*) n_key_map_previous_system

private

Definition at line 618 of file PlayerEntity.h.

n_key_map_zoom_in

- (NSArray*) n_key_map_zoom_in

private

Definition at line 620 of file PlayerEntity.h.

n_key_map_zoom_out

- (NSArray*) n_key_map_zoom_out

private

Definition at line 621 of file PlayerEntity.h.

n_key_market_buy_max

- (NSArray*) n_key_market_buy_max

private

Definition at line 644 of file PlayerEntity.h.

n_key_market_buy_one

- (NSArray*) n_key_market_buy_one

private

Definition at line 642 of file PlayerEntity.h.

n_key_market_filter_cycle

- (NSArray*) n_key_market_filter_cycle

private

Definition at line 640 of file PlayerEntity.h.

n_key_market_sell_max

- (NSArray*) n_key_market_sell_max

private

Definition at line 645 of file PlayerEntity.h.

n_key_market_sell_one

- (NSArray*) n_key_market_sell_one

private

Definition at line 643 of file PlayerEntity.h.

n_key_market_sorter_cycle

- (NSArray*) n_key_market_sorter_cycle

private

Definition at line 641 of file PlayerEntity.h.

n_key_mode_equipment

- (NSArray*) n_key_mode_equipment

private

Definition at line 584 of file PlayerEntity.h.

n_key_mouse_control_roll

- (NSArray*) n_key_mouse_control_roll

private

Definition at line 631 of file PlayerEntity.h.

n_key_mouse_control_yaw

- (NSArray*) n_key_mouse_control_yaw

private

Definition at line 632 of file PlayerEntity.h.

n_key_next_compass_mode

- (NSArray*) n_key_next_compass_mode

private

Definition at line 637 of file PlayerEntity.h.

n_key_next_missile

- (NSArray*) n_key_next_missile

private

Definition at line 578 of file PlayerEntity.h.

n_key_next_target

- (NSArray*) n_key_next_target

private

Definition at line 647 of file PlayerEntity.h.

n_key_oxzmanager_extract

- (NSArray*) n_key_oxzmanager_extract

private

Definition at line 674 of file PlayerEntity.h.

n_key_oxzmanager_setfilter

- (NSArray*) n_key_oxzmanager_setfilter

private

Definition at line 672 of file PlayerEntity.h.

n_key_oxzmanager_showinfo

- (NSArray*) n_key_oxzmanager_showinfo

private

Definition at line 673 of file PlayerEntity.h.

n_key_pausebutton

- (NSArray*) n_key_pausebutton

private

Definition at line 628 of file PlayerEntity.h.

n_key_pitch_back

- (NSArray*) n_key_pitch_back

private

Definition at line 546 of file PlayerEntity.h.

n_key_pitch_forward

- (NSArray*) n_key_pitch_forward

private

Definition at line 545 of file PlayerEntity.h.

n_key_prev_compass_mode

- (NSArray*) n_key_prev_compass_mode

private

Definition at line 636 of file PlayerEntity.h.

n_key_previous_target

- (NSArray*) n_key_previous_target

private

Definition at line 648 of file PlayerEntity.h.

n_key_prime_next_equipment

- (NSArray*) n_key_prime_next_equipment

private

Definition at line 581 of file PlayerEntity.h.

n_key_prime_previous_equipment

- (NSArray*) n_key_prime_previous_equipment

private

Definition at line 582 of file PlayerEntity.h.

n_key_roll_left

- (NSArray*) n_key_roll_left

private

Definition at line 543 of file PlayerEntity.h.

n_key_roll_right

- (NSArray*) n_key_roll_right

private

Definition at line 544 of file PlayerEntity.h.

n_key_rotate_cargo

- (NSArray*) n_key_rotate_cargo

private

Definition at line 603 of file PlayerEntity.h.

n_key_scanner_unzoom

- (NSArray*) n_key_scanner_unzoom

private

Definition at line 594 of file PlayerEntity.h.

n_key_scanner_zoom

- (NSArray*) n_key_scanner_zoom

private

Definition at line 593 of file PlayerEntity.h.

n_key_show_fps

- (NSArray*) n_key_show_fps

private

Definition at line 629 of file PlayerEntity.h.

n_key_snapshot

- (NSArray*) n_key_snapshot

private

Definition at line 608 of file PlayerEntity.h.

n_key_switch_next_mfd

- (NSArray*) n_key_switch_next_mfd

private

Definition at line 669 of file PlayerEntity.h.

n_key_switch_previous_mfd

- (NSArray*) n_key_switch_previous_mfd

private

Definition at line 670 of file PlayerEntity.h.

n_key_system_end

- (NSArray*) n_key_system_end

private

Definition at line 624 of file PlayerEntity.h.

n_key_system_home

- (NSArray*) n_key_system_home

private

Definition at line 623 of file PlayerEntity.h.

n_key_system_next_system

- (NSArray*) n_key_system_next_system

private

Definition at line 625 of file PlayerEntity.h.

n_key_system_previous_system

- (NSArray*) n_key_system_previous_system

private

Definition at line 626 of file PlayerEntity.h.

n_key_target_incoming_missile

- (NSArray*) n_key_target_incoming_missile

private

Definition at line 590 of file PlayerEntity.h.

n_key_target_missile

- (NSArray*) n_key_target_missile

private

Definition at line 588 of file PlayerEntity.h.

n_key_untarget_missile

- (NSArray*) n_key_untarget_missile

private

Definition at line 589 of file PlayerEntity.h.

n_key_view_aft

- (NSArray*) n_key_view_aft

private

Definition at line 551 of file PlayerEntity.h.

n_key_view_forward

- (NSArray*) n_key_view_forward

private

Definition at line 550 of file PlayerEntity.h.

n_key_view_port

- (NSArray*) n_key_view_port

private

Definition at line 552 of file PlayerEntity.h.

n_key_view_starboard

- (NSArray*) n_key_view_starboard

private

Definition at line 553 of file PlayerEntity.h.

n_key_weapons_online_toggle

- (NSArray*) n_key_weapons_online_toggle

private

Definition at line 665 of file PlayerEntity.h.

n_key_yaw_left

- (NSArray*) n_key_yaw_left

private

Definition at line 547 of file PlayerEntity.h.

n_key_yaw_right

- (NSArray*) n_key_yaw_right

private

Definition at line 548 of file PlayerEntity.h.

occlusion_dial

- (float) occlusion_dial

private

Definition at line 372 of file PlayerEntity.h.

parcel_record

- (NSMutableDictionary*) parcel_record

private

Definition at line 412 of file PlayerEntity.h.

parcels

- (NSMutableArray*) parcels

private

Definition at line 411 of file PlayerEntity.h.

passenger_record

- (NSMutableDictionary*) passenger_record

private

Definition at line 409 of file PlayerEntity.h.

passengers

- (NSMutableArray*) passengers

private

Definition at line 408 of file PlayerEntity.h.

pitch_delta

- (GLfloat) pitch_delta

private

Definition at line 470 of file PlayerEntity.h.

pitching

- (unsigned) pitching

private

Definition at line 760 of file PlayerEntity.h.

planetSearchString

- (NSString*) planetSearchString

private

Definition at line 439 of file PlayerEntity.h.

playerRotMatrix

- (OOMatrix) playerRotMatrix

private

Definition at line 441 of file PlayerEntity.h.

pollControls

- (BOOL) pollControls

private

Definition at line 449 of file PlayerEntity.h.

port_shot_time

- (OOTimeDelta) port_shot_time

private

Definition at line 475 of file PlayerEntity.h.

portViewOffset

- (Vector) portViewOffset

private

Definition at line 707 of file PlayerEntity.h.

previous_system_id

- (OOSystemID) previous_system_id

private

Definition at line 370 of file PlayerEntity.h.

primedEquipment

- (NSUInteger) primedEquipment

private

Definition at line 489 of file PlayerEntity.h.

replacingMissile

- (unsigned) replacingMissile

private

Definition at line 773 of file PlayerEntity.h.

reputation

- (NSMutableDictionary*) reputation

private

Provided by category PlayerEntity(Contracts).

Definition at line 405 of file PlayerEntity.h.

roleSystemList

- (NSMutableArray*) roleSystemList

private

Definition at line 423 of file PlayerEntity.h.

roleWeightFlags

- (NSMutableDictionary*) roleWeightFlags

private

Definition at line 422 of file PlayerEntity.h.

roleWeights

- (NSMutableArray *) roleWeights

private

Definition at line 420 of file PlayerEntity.h.

Referenced by PlayerGetProperty().

roll_delta

- (GLfloat) roll_delta

private

Definition at line 470 of file PlayerEntity.h.

rolling

- (unsigned) rolling

private

Definition at line 760 of file PlayerEntity.h.

save_path

- (NSString*) save_path

private

Definition at line 703 of file PlayerEntity.h.

saved_chart_zoom

- (OOScalar) saved_chart_zoom

private

Definition at line 507 of file PlayerEntity.h.

scannedWormholes

- (NSArray *) scannedWormholes

private

Definition at line 802 of file PlayerEntity.h.

scanner_zoom_rate

- (GLfloat) scanner_zoom_rate

private

Definition at line 716 of file PlayerEntity.h.

scenarioKey

- (NSString*) scenarioKey

private

Definition at line 704 of file PlayerEntity.h.

scoopOverride

- (BOOL) scoopOverride

private

Definition at line 737 of file PlayerEntity.h.

scoopsActive

- (unsigned) scoopsActive

private

Definition at line 735 of file PlayerEntity.h.

script_time

- (double) script_time

private

Definition at line 425 of file PlayerEntity.h.

script_time_check

- (double) script_time_check

private

Definition at line 426 of file PlayerEntity.h.

script_time_interval

- (double) script_time_interval

private

Definition at line 427 of file PlayerEntity.h.

selFunctionIdx

- (int) selFunctionIdx

private

Definition at line 784 of file PlayerEntity.h.

ship_clock

- (double) ship_clock

private

Definition at line 430 of file PlayerEntity.h.

ship_clock_adjust

- (double) ship_clock_adjust

private

Definition at line 431 of file PlayerEntity.h.

ship_kills

- (unsigned) ship_kills

private

Definition at line 528 of file PlayerEntity.h.

ship_trade_in_factor

- (int) ship_trade_in_factor

private

Definition at line 375 of file PlayerEntity.h.

shipCommodityData

- (OOCommodityMarket *) shipCommodityData

private

Definition at line 521 of file PlayerEntity.h.

shipyard_record

- (NSMutableDictionary*) shipyard_record

private

Definition at line 417 of file PlayerEntity.h.

show_info_flag

- (unsigned) show_info_flag

private

Definition at line 756 of file PlayerEntity.h.

showDemoShips

- (BOOL) showDemoShips

private

Definition at line 758 of file PlayerEntity.h.

showingLongRangeChart

- (BOOL) showingLongRangeChart

private

Definition at line 443 of file PlayerEntity.h.

specialCargo

- (NSString *) specialCargo

private

Definition at line 391 of file PlayerEntity.h.

Referenced by PlayerShipGetProperty().

starboard_shot_time

- (OOTimeDelta) starboard_shot_time

private

Definition at line 475 of file PlayerEntity.h.

starboardViewOffset

- (Vector) starboardViewOffset

private

Definition at line 707 of file PlayerEntity.h.

stickFunctions

- (NSArray*) stickFunctions

private

Definition at line 785 of file PlayerEntity.h.

stickProfileScreen

- (StickProfileScreen*) stickProfileScreen

private

Definition at line 808 of file PlayerEntity.h.

suppressTargetLost

- (void) suppressTargetLost

private

Definition at line 734 of file PlayerEntity.h.

system_id

- (OOSystemID) system_id

private

Definition at line 367 of file PlayerEntity.h.

target_chart_centre

- (NSPoint) target_chart_centre

private

Definition at line 500 of file PlayerEntity.h.

target_chart_focus

- (NSPoint) target_chart_focus

private

Definition at line 501 of file PlayerEntity.h.

target_chart_zoom

- (OOScalar) target_chart_zoom

private

Definition at line 506 of file PlayerEntity.h.

target_memory

- (NSMutableArray*) target_memory

private

Definition at line 720 of file PlayerEntity.h.

target_memory_index

- (NSUInteger) target_memory_index

private

Definition at line 721 of file PlayerEntity.h.

target_system_id

- (OOSystemID) target_system_id

private

Definition at line 368 of file PlayerEntity.h.

targetDockStation

- (StationEntity*) targetDockStation

private

Definition at line 462 of file PlayerEntity.h.

travelling_at_hyperspeed

- (unsigned) travelling_at_hyperspeed

private

Definition at line 747 of file PlayerEntity.h.

trumble

- (OOTrumble* trumble[PLAYER_MAX_TRUMBLES])

private

Definition at line 712 of file PlayerEntity.h.

trumbleCount

- (NSUInteger) trumbleCount

private

Definition at line 711 of file PlayerEntity.h.

using_mining_laser

- (unsigned) using_mining_laser

private

Definition at line 761 of file PlayerEntity.h.

waitingForStickCallback

- (unsigned) waitingForStickCallback

private

Definition at line 768 of file PlayerEntity.h.

weapons_online

- (unsigned) weapons_online

private

Definition at line 770 of file PlayerEntity.h.

witchspaceCountdown

- (OOTimeDelta) witchspaceCountdown

private

Definition at line 509 of file PlayerEntity.h.

worldScripts

- (NSDictionary*) worldScripts

private

Definition at line 377 of file PlayerEntity.h.

worldScriptsRequiringTickle

- (NSDictionary*) worldScriptsRequiringTickle

private

Provided by category PlayerEntity(Scripting).

Definition at line 378 of file PlayerEntity.h.

wormhole

- (WormholeEntity *) wormhole

private

Definition at line 803 of file PlayerEntity.h.

yaw_delta

- (GLfloat) yaw_delta

private

Definition at line 470 of file PlayerEntity.h.

yawing

- (unsigned) yawing

private

Definition at line 760 of file PlayerEntity.h.

---

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

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