PlayerEntity(OOPrivate) Category Reference

Instance Methods
(void)	- setExtraEquipmentFromFlags
(void)	- doTradeIn:forPriceFactor:
(void)	- updateMovementFlags
(void)	- updateAlertCondition
(void)	- updateFuelScoops:
(void)	- updateClocks:
(void)	- checkScriptsIfAppropriate
(void)	- updateTrumbles:
(void)	- performAutopilotUpdates:
(void)	- performInFlightUpdates:
(void)	- performWitchspaceCountdownUpdates:
(void)	- performWitchspaceExitUpdates:
(void)	- performLaunchingUpdates:
(void)	- performDockingUpdates:
(void)	- performDeadUpdates:
(void)	- gameOverFadeToBW
(void)	- updateTargeting
(void)	- showGameOver
(void)	- updateWormholes
(void)	- updateAlertConditionForNearbyEntities
(BOOL)	- checkEntityForMassLock:withScanClass:
(void)	- showMarketScreenHeaders
(void)	- showMarketScreenDataLine:forGood:inMarket:holdQuantity:
(void)	- showMarketCashAndLoadLine
(BOOL)	- tryBuyingItem:
(NSArray *)	- contractsListForScriptingFromArray:forCargo:
(void)	- prepareMarkedDestination:markers:
(void)	- witchStart
(void)	- witchJumpTo:misjump:
(void)	- witchEnd
(double)	- hyperspaceJumpDistance
(OOFuelQuantity)	- fuelRequiredForJump
(void)	- noteCompassLostTarget

Detailed Description

Definition at line 113 of file PlayerEntity.m.

Method Documentation

checkEntityForMassLock:withScanClass:

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

Extends class PlayerEntity.

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

References Entity::collision_radius, EXPECT, EXPECT_NOT, ShipEntity::isCloaked, Entity::isShip, Entity::isSun, SCANNER_MAX_RANGE2, STELLAR_TYPE_MINIATURE, and Entity::zero_distance.

Referenced by updateAlertConditionForNearbyEntities.

Here is the call graph for this function:

Here is the caller graph for this function:

checkScriptsIfAppropriate

- (void) checkScriptsIfAppropriate

Extends class PlayerEntity.

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

References PlayerEntity::checkScript, and checkScriptsIfAppropriate.

Referenced by checkScriptsIfAppropriate, setExtraEquipmentFromFlags, and PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

contractsListForScriptingFromArray:forCargo:

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

Extends class PlayerEntity.

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

Referenced by PlayerEntity::contractListForScripting, PlayerEntity::parcelListForScripting, and PlayerEntity::passengerListForScripting.

Here is the caller graph for this function:

doTradeIn:forPriceFactor:

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

Extends class PlayerEntity.

Definition at line 10704 of file PlayerEntity.m.

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

Referenced by tryBuyingItem:.

Here is the caller graph for this function:

fuelRequiredForJump

- (OOFuelQuantity) fuelRequiredForJump

Extends class PlayerEntity.

Definition at line 7508 of file PlayerEntity.m.

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

References fuelRequiredForJump, hyperspaceJumpDistance, and MAX.

Referenced by PlayerEntity::dialHyperRange, PlayerEntity::enterWitchspace, fuelRequiredForJump, PlayerEntity::hasSufficientFuelForJump, and setExtraEquipmentFromFlags.

Here is the call graph for this function:

Here is the caller graph for this function:

gameOverFadeToBW

- (void) gameOverFadeToBW

Extends class PlayerEntity.

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

References MyOpenGLView::adjustColorSaturation:, MyOpenGLView::colorSaturation, DETAIL_LEVEL_SHADERS, gameOverFadeToBW, kDeadResetTime, and UNIVERSE.

Referenced by gameOverFadeToBW, performDeadUpdates:, and setExtraEquipmentFromFlags.

Here is the call graph for this function:

Here is the caller graph for this function:

hyperspaceJumpDistance

- (double) hyperspaceJumpDistance

Extends class PlayerEntity.

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

References distanceBetweenPlanetPositions(), hyperspaceJumpDistance, PointFromString(), and UNIVERSE.

Referenced by fuelRequiredForJump, hyperspaceJumpDistance, setExtraEquipmentFromFlags, and PlayerEntity::witchJumpChecklist:.

Here is the call graph for this function:

Here is the caller graph for this function:

noteCompassLostTarget

- (void) noteCompassLostTarget

Extends class PlayerEntity.

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

References PlayerEntity::hud, noteCompassLostTarget, OOJSAcquireContext(), OOJSRelinquishContext(), OOJSValueFromCompassMode(), HeadUpDisplay::setCompassActive:, and ShipScriptEvent.

Referenced by PlayerEntity::enterGalacticWitchspace, PlayerEntity::enterWitchspace, noteCompassLostTarget, and setExtraEquipmentFromFlags.

Here is the call graph for this function:

Here is the caller graph for this function:

performAutopilotUpdates:

- (void) performAutopilotUpdates:

(OOTimeDelta)

delta_t

Extends class PlayerEntity.

Definition at line 3612 of file PlayerEntity.m.

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

References Entity::applyVelocity:, PlayerEntity::doBookkeeping:, and ShipEntity::processBehaviour:.

Referenced by PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

performDeadUpdates:

- (void) performDeadUpdates:

(OOTimeDelta)

delta_t

Extends class PlayerEntity.

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

References PlayerEntity::gameOverFadeToBW, kDeadResetTime, and UNIVERSE.

Referenced by PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

performDockingUpdates:

- (void) performDockingUpdates:

(OOTimeDelta)

delta_t

Extends class PlayerEntity.

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

References PlayerEntity::docked, and UNIVERSE.

Referenced by PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

performInFlightUpdates:

- (void) performInFlightUpdates:

(OOTimeDelta)

delta_t

Extends class PlayerEntity.

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

References ShipEntity::afterburnerFactor, PlayerEntity::applyRoll:andClimb:, Entity::applyVelocity:, PlayerEntity::applyYaw:, HYPERSPEED_FACTOR, kZeroVector, PlayerEntity::moveForward:, STAGE_TRACKING_BEGIN, STAGE_TRACKING_END, UPDATE_STAGE, PlayerEntity::updateTargeting, VELOCITY_CLEANUP_FULL, VELOCITY_CLEANUP_MIN, and VELOCITY_CLEANUP_RATE.

Referenced by PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

performLaunchingUpdates:

- (void) performLaunchingUpdates:

(OOTimeDelta)

delta_t

Extends class PlayerEntity.

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

References PlayerEntity::checkScript, PlayerEntity::doBookkeeping:, ShipEntity::doScriptEvent:withArgument:, PlayerEntity::setDockingClearanceStatus:, ShipEntity::setStatus:, and UNIVERSE.

Referenced by PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

performWitchspaceCountdownUpdates:

- (void) performWitchspaceCountdownUpdates:

(OOTimeDelta)

delta_t

Extends class PlayerEntity.

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

References PlayerEntity::doBookkeeping:, PlayerEntity::enterGalacticWitchspace, PlayerEntity::enterWitchspace, EXPECT_NOT, PlayerEntity::nextHopTargetSystemID, OOJSSTR, PlayerEntity::playHyperspaceAborted, ShipEntity::setStatus:, ShipScriptEventNoCx, STAGE_TRACKING_BEGIN, STAGE_TRACKING_END, and UPDATE_STAGE.

Referenced by PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

performWitchspaceExitUpdates:

- (void) performWitchspaceExitUpdates:

(OOTimeDelta)

delta_t

Extends class PlayerEntity.

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

References PlayerEntity::checkScript, PlayerEntity::doBookkeeping:, ShipEntity::doScriptEvent:withArgument:, PlayerEntity::jumpCause, ShipEntity::resetExhaustPlumes, PlayerEntity::resetScriptTimer, ShipEntity::setScriptedMisjump:, ShipEntity::setScriptedMisjumpRange:, ShipEntity::setStatus:, and UNIVERSE.

Referenced by PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

prepareMarkedDestination:markers:

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

Extends class PlayerEntity.

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

References nil.

setExtraEquipmentFromFlags

- (void) setExtraEquipmentFromFlags

Extends class PlayerEntity.

References checkScriptsIfAppropriate, fuelRequiredForJump, gameOverFadeToBW, hyperspaceJumpDistance, noteCompassLostTarget, setExtraEquipmentFromFlags, showGameOver, showMarketCashAndLoadLine, showMarketScreenHeaders, updateAlertCondition, updateAlertConditionForNearbyEntities, updateMovementFlags, updateTargeting, updateWormholes, witchEnd, and witchStart.

Referenced by setExtraEquipmentFromFlags.

Here is the call graph for this function:

Here is the caller graph for this function:

showGameOver

- (void) showGameOver

Extends class PlayerEntity.

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

References ShipEntity::resetShotTime, and showGameOver.

Referenced by PlayerEntity::doBookkeeping:, PlayerEntity::getDestroyedBy:damageType:, setExtraEquipmentFromFlags, and showGameOver.

Here is the call graph for this function:

Here is the caller graph for this function:

showMarketCashAndLoadLine

- (void) showMarketCashAndLoadLine

Extends class PlayerEntity.

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

References GuiDisplayGen::colorFromSetting:defaultValue:, ShipEntity::maxAvailableCargoSpace, GuiDisplayGen::setColor:forRow:, GuiDisplayGen::setText:forRow:, showMarketCashAndLoadLine, and OOColor::yellowColor.

Referenced by setExtraEquipmentFromFlags, PlayerEntity::setGuiToMarketInfoScreen, PlayerEntity::setGuiToMarketScreen, and showMarketCashAndLoadLine.

Here is the call graph for this function:

Here is the caller graph for this function:

showMarketScreenDataLine:forGood:inMarket:holdQuantity:

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

Extends class PlayerEntity.

Definition at line 10960 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:@" %@.%lu ",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++];
 
}

References GuiDisplayGen::colorFromSetting:defaultValue:, DESC, DisplayStringForMassUnit(), OOCommodityMarket::exportLegalityForGood:, OOCommodityMarket::importLegalityForGood:, nil, OOPadStringToEms(), OOCommodityMarket::priceForGood:, OOCommodityMarket::quantityForGood:, GuiDisplayGen::setArray:forRow:, GuiDisplayGen::setColor:forRow:, and GuiDisplayGen::setKey:forRow:.

Referenced by PlayerEntity::setGuiToMarketInfoScreen, and PlayerEntity::setGuiToMarketScreen.

Here is the call graph for this function:

Here is the caller graph for this function:

showMarketScreenHeaders

- (void) showMarketScreenHeaders

Extends class PlayerEntity.

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

References GuiDisplayGen::colorFromSetting:defaultValue:, OOColor::greenColor, GuiDisplayGen::overrideTabs:from:length:, GuiDisplayGen::setArray:forRow:, GuiDisplayGen::setColor:forRow:, GuiDisplayGen::setTabStops:, and showMarketScreenHeaders.

Referenced by setExtraEquipmentFromFlags, PlayerEntity::setGuiToMarketInfoScreen, PlayerEntity::setGuiToMarketScreen, and showMarketScreenHeaders.

Here is the call graph for this function:

Here is the caller graph for this function:

tryBuyingItem:

- (BOOL) tryBuyingItem:

(NSString *)

eqKey

Extends class PlayerEntity.

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

References PlayerEntity::addEquipmentItem:withValidation:inContext:, PlayerEntity::adjustPriceByScriptForEqKey:withCurrent:, PlayerEntity::changePassengerBerths:, ShipEntity::clearSubEntities, OOEquipmentType::damagedIdentifier, PlayerEntity::dockedStation, ShipEntity::doScriptEvent:withArgument:, PlayerEntity::doTradeIn:forPriceFactor:, ENERGY_UNIT_NAVAL, ENERGY_UNIT_NAVAL_DAMAGED, ENERGY_UNIT_NONE, ENERGY_UNIT_NORMAL, ENERGY_UNIT_NORMAL_DAMAGED, StationEntity::equipmentPriceFactor, OOEquipmentType::equipmentTypeWithIdentifier:, StationEntity::equivalentTechLevel, ShipEntity::fuel, ShipEntity::fuelCapacity, kOOLogBuyMountedFailed, kOOLogBuyMountedOK, PlayerEntity::mountMissile:, nil, OOLog, OOWeaponTypeFromEquipmentIdentifierStrict(), PASSENGER_BERTH_SPACE, OOEquipmentType::price, PlayerEntity::removeEquipmentItem:, PlayerEntity::removeMissiles, PlayerEntity::renovationCosts, PlayerEntity::safeAllMissiles, PlayerEntity::setActiveMissile:, PlayerEntity::setGuiToEquipShipScreen:selectingFacingFor:, ShipEntity::setUpSubEntities, PlayerEntity::tidyMissilePylons, WEAPON_FACING_AFT, WEAPON_FACING_FORWARD, WEAPON_FACING_NONE, WEAPON_FACING_PORT, and WEAPON_FACING_STARBOARD.

Here is the call graph for this function:

updateAlertCondition

- (void) updateAlertCondition

Extends class PlayerEntity.

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

References ALERT_CONDITION_DOCKED, ALERT_CONDITION_GREEN, ALERT_CONDITION_RED, ALERT_CONDITION_YELLOW, PlayerEntity::alertCondition, PLAYER_FLEEING_CARGO, PLAYER_FLEEING_LIKELY, PLAYER_FLEEING_MAYBE, PLAYER_FLEEING_NONE, PLAYER_FLEEING_UNLIKELY, ShipScriptEventNoCx, updateAlertCondition, and PlayerEntity::updateAlertConditionForNearbyEntities.

Referenced by setExtraEquipmentFromFlags, PlayerEntity::setMassLockable:, PlayerEntity::update:, and updateAlertCondition.

Here is the call graph for this function:

Here is the caller graph for this function:

updateAlertConditionForNearbyEntities

- (void) updateAlertConditionForNearbyEntities

Extends class PlayerEntity.

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

References PlayerEntity::checkEntityForMassLock:withScanClass:, PlayerEntity::clearAlertFlags, Entity::collisionRadius, PlayerEntity::dialAltitude, EXPECT_NOT, ShipEntity::hasHostileTarget, ShipEntity::hullHeatLevel, Entity::isShip, MAX_HYPERSPEED_FACTOR, MIN_HYPERSPEED_FACTOR, nil, ShipEntity::primaryTarget, Entity::scanClass, SCANNER_MAX_RANGE, SCANNER_MAX_RANGE2, PlayerEntity::setAlertFlag:to:, UNIVERSE, updateAlertConditionForNearbyEntities, and Entity::zero_distance.

Referenced by setExtraEquipmentFromFlags, updateAlertCondition, and updateAlertConditionForNearbyEntities.

Here is the call graph for this function:

Here is the caller graph for this function:

updateClocks:

- (void) updateClocks:

(OOTimeDelta)

delta_t

Extends class PlayerEntity.

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

References ShipEntity::doScriptEvent:withArgument:, int(), MINIMUM_GAME_TICK, and UNIVERSE.

Referenced by PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

updateFuelScoops:

- (void) updateFuelScoops:

(OOTimeDelta)

delta_t

Extends class PlayerEntity.

Definition at line 3472 of file PlayerEntity.m.

                         :(OOTimeDelta)delta_t
{
    if (scoopsActive)
    {
        [self updateFuelScoopSoundWithInterval:delta_t];
        if (![self scoopOverride])
        {
            scoopsActive = NO;
            [self updateFuelScoopSoundWithInterval:delta_t];
        }
    }
}

References PlayerEntity::updateFuelScoopSoundWithInterval:.

Referenced by PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

updateMovementFlags

- (void) updateMovementFlags

Extends class PlayerEntity.

Definition at line 3206 of file PlayerEntity.m.

{
    hasMoved = !HPvector_equal(position, lastPosition);
    hasRotated = !quaternion_equal(orientation, lastOrientation);
    lastPosition = position;
    lastOrientation = orientation;
}

References updateMovementFlags.

Referenced by setExtraEquipmentFromFlags, PlayerEntity::update:, and updateMovementFlags.

Here is the call graph for this function:

Here is the caller graph for this function:

updateTargeting

- (void) updateTargeting

Extends class PlayerEntity.

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

References PlayerEntity::addTarget:, PlayerEntity::clockTimeAdjusted, WormholeEntity::destination, DESTROY, Entity::dumpState, WormholeEntity::estimatedArrivalTime, kOOLogInconsistentState, MISSILE_STATUS_ARMED, MISSILE_STATUS_SAFE, nil, ShipEntity::noteLostTarget, OOLog, PlayerEntity::playTargetLost, ShipEntity::primaryTarget, WormholeEntity::setScanInfo:, WormholeEntity::setScannedAt:, STAGE_TRACKING_BEGIN, STAGE_TRACKING_END, UPDATE_STAGE, updateTargeting, WH_SCANINFO_ARRIVAL_TIME, WH_SCANINFO_COLLAPSE_TIME, WH_SCANINFO_DESTINATION, WH_SCANINFO_NONE, WH_SCANINFO_SCANNED, and WH_SCANINFO_SHIP.

Referenced by performInFlightUpdates:, setExtraEquipmentFromFlags, and updateTargeting.

Here is the call graph for this function:

Here is the caller graph for this function:

updateTrumbles:

- (void) updateTrumbles:

(OOTimeDelta)

delta_t

Extends class PlayerEntity.

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

References PlayerEntity::trumbleArray, and OOTrumble::updateTrumble:.

Referenced by PlayerEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

updateWormholes

- (void) updateWormholes

Extends class PlayerEntity.

Definition at line 13243 of file PlayerEntity.m.

{
    assert(scannedWormholes != nil);
    
    if ([scannedWormholes count] == 0)
        return;
 
    double now = [self clockTimeAdjusted];
 
    NSMutableArray * savedWormholes = [[NSMutableArray alloc] initWithCapacity:[scannedWormholes count]];
    NSEnumerator * wormholes = [scannedWormholes objectEnumerator];
    WormholeEntity *wh;
 
    while ((wh = (WormholeEntity*)[wormholes nextObject]))
    {
        // 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;
}

References PlayerEntity::clockTimeAdjusted, count, WormholeEntity::disgorgeShips, nil, and updateWormholes.

Referenced by setExtraEquipmentFromFlags, PlayerEntity::update:, and updateWormholes.

Here is the call graph for this function:

Here is the caller graph for this function:

witchEnd

- (void) witchEnd

Extends class PlayerEntity.

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

References witchEnd.

Referenced by PlayerEntity::enterGalacticWitchspace, setExtraEquipmentFromFlags, witchEnd, and witchJumpTo:misjump:.

Here is the call graph for this function:

Here is the caller graph for this function:

witchJumpTo:misjump:

- (void) witchJumpTo:		(OOSystemID)	sTo
misjump:		(BOOL)	misjump

Extends class PlayerEntity.

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

References PlayerEntity::adjustTradeInFactorBy:, distanceBetweenPlanetPositions(), PlayerEntity::erodeReputation, PlayerEntity::playWitchjumpMisjump, PointFromString(), randf(), OOSunEntity::resetNova, PlayerEntity::setBounty:withReason:, PlayerEntity::setInfoSystemID:moveChart:, PlayerEntity::setSystemID:, UNIVERSE, PlayerEntity::witchEnd, and PlayerEntity::witchStart.

Referenced by PlayerEntity::enterWitchspace, and PlayerEntity::enterWormhole:.

Here is the call graph for this function:

Here is the caller graph for this function:

witchStart

- (void) witchStart

Extends class PlayerEntity.

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

References PlayerEntity::currentWeaponStats, DESTROY, PlayerEntity::disengageAutopilot, kOOLogInconsistentState, nil, ShipEntity::noteLostTarget, PlayerEntity::noteSwitchToView:fromView:, OOLog, ranrot_rand, PlayerEntity::safeAllMissiles, ShipEntity::transitionToAegisNone, WEAPON_FACING_FORWARD, and witchStart.

Referenced by PlayerEntity::enterGalacticWitchspace, setExtraEquipmentFromFlags, witchJumpTo:misjump:, and witchStart.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/Core/Entities/PlayerEntity.m