ShipEntity(Private) Category Reference

Instance Methods
(void)	- subEntityDied:
(void)	- subEntityReallyDied:
(void)	- drawDebugStuff
(void)	- rescaleBy:
(void)	- rescaleBy:writeToCache:
(BOOL)	- setUpOneSubentity:
(BOOL)	- setUpOneFlasher:
(Entity< OOStellarBody > *)	- lastAegisLock
(void)	- addSubEntity:
(void)	- refreshEscortPositions
(HPVector)	- coordinatesForEscortPosition:
(void)	- setUpMixedEscorts
(void)	- setUpOneEscort:inGroup:withRole:atPosition:andCount:
(void)	- addSubentityToCollisionRadius:
(ShipEntity *)	- launchPodWithCrew:
(OOEquipmentType *)	- generateMissileEquipmentTypeFrom:
(void)	- setShipHitByLaser:
(void)	- noteFrustration:
(BOOL)	- cloakPassive

Detailed Description

Definition at line 131 of file ShipEntity.m.

Method Documentation

addSubEntity:

- (void) addSubEntity:

(Entity< OOSubEntity > *)

subent

Extends class ShipEntity.

Definition at line 6493 of file ShipEntity.m.

                     :(Entity<OOSubEntity> *)sub
{
    if (sub == nil)  return;
    
    if (subEntities == nil)  subEntities = [[NSMutableArray alloc] init];
    sub->isSubEntity = YES;
    // Order matters - need consistent state in setOwner:. -- Ahruman 2008-04-20
    [subEntities addObject:sub];
    [sub setOwner:self];
    
    [self addSubentityToCollisionRadius:sub];
}

addSubentityToCollisionRadius:

- (void) addSubentityToCollisionRadius:

(Entity< OOSubEntity > *)

subent

Extends class ShipEntity.

Definition at line 2092 of file ShipEntity.m.

                                      :(Entity<OOSubEntity> *)subent
{
    if (!subent)  return;
    
    double distance = HPmagnitude([subent position]) + [subent findCollisionRadius];
    if ([subent isKindOfClass:[ShipEntity class]])  // Solid subentity
    {
        if (distance > collision_radius)
        {
            collision_radius = distance;
        }
        
        mass += [subent mass];
    }
    if (distance > _profileRadius)
    {
        _profileRadius = distance;
    }
}

cloakPassive

- (BOOL) cloakPassive

Extends class ShipEntity.

Definition at line 266 of file ShipEntity.h.

coordinatesForEscortPosition:

- (HPVector) coordinatesForEscortPosition:

(unsigned)

idx

Extends class ShipEntity.

Definition at line 9589 of file ShipEntity.m.

                                         :(unsigned)idx
{
    /*
        This function causes problems with Thargoids: their missiles (aka Thargons) are automatically
        added to the escorts group, and when a mother ship dies all thargons will attach themselves
        as escorts to the surviving battleships. This can lead to huge escort groups.
        TODO: better handling of Thargoid groups:
            - put thargons (& all other thargon missiles) in their own non-escort group perhaps?
    */
    
    // The _escortPositions array is always MAX_ESCORTS long.
    // Kludge: return the same last escort position if we have escorts above MAX_ESCORTS...
    idx = MIN(idx, (unsigned)(MAX_ESCORTS - 1));
    
    return HPvector_add(self->position, vectorToHPVector(quaternion_rotate_vector([self normalOrientation], _escortPositions[idx])));
}

drawDebugStuff

- (void) drawDebugStuff

Extends class ShipEntity.

Definition at line 2092 of file ShipEntity.m.

{
    // HPVect: imprecise here - needs camera relative
    if (0 && reportAIMessages)
    {
        OODebugDrawPoint(HPVectorToVector(_destination), [OOColor blueColor]);
        OODebugDrawColoredLine(HPVectorToVector([self position]), HPVectorToVector(_destination), [OOColor colorWithWhite:0.15 alpha:1.0]);
        
        Entity *pTarget = [self primaryTarget];
        if (pTarget != nil)
        {
            OODebugDrawPoint(HPVectorToVector([pTarget position]), [OOColor redColor]);
            OODebugDrawColoredLine(HPVectorToVector([self position]), HPVectorToVector([pTarget position]), [OOColor colorWithRed:0.2 green:0.0 blue:0.0 alpha:1.0]);
        }
        
        Entity *sTarget = [self targetStation];
        if (sTarget != pTarget && [sTarget isStation])
        {
            OODebugDrawPoint(HPVectorToVector([sTarget position]), [OOColor cyanColor]);
        }
        
        Entity *fTarget = [self foundTarget];
        if (fTarget != nil && fTarget != pTarget && fTarget != sTarget)
        {
            OODebugDrawPoint(HPVectorToVector([fTarget position]), [OOColor magentaColor]);
        }
    }
}

generateMissileEquipmentTypeFrom:

- (OOEquipmentType *) generateMissileEquipmentTypeFrom:

(NSString *)

role

Extends class ShipEntity.

Definition at line 2092 of file ShipEntity.m.

                                                      :(NSString *)role
{
    /*  The generated missile equipment type provides for backward compatibility with pre-1.74 OXPs  missile_roles
        and follows this template:
        
        //NPC equipment, incompatible with player ship. Not buyable because of its TL.
        (
            100, 100000, "Missile",
            "EQ_X_MISSILE",
            "Unidentified missile type.",
            {
                is_external_store = true;
            }
        )
    */
    NSArray  *itemInfo = [NSArray arrayWithObjects:@"100", @"100000", @"Missile", role, @"Unidentified missile type.",
                            [NSDictionary dictionaryWithObjectsAndKeys: @"true", @"is_external_store", nil], nil];
    
    [OOEquipmentType addEquipmentWithInfo:itemInfo];
    return [OOEquipmentType equipmentTypeWithIdentifier:role];
}

lastAegisLock

- (Entity< OOStellarBody > *) lastAegisLock

Extends class ShipEntity.

Definition at line 7616 of file ShipEntity.m.

{
    Entity<OOStellarBody> *stellar = [_lastAegisLock weakRefUnderlyingObject];
    if (stellar == nil)
    {
        [_lastAegisLock release];
        _lastAegisLock = nil;
    }
    
    return stellar;
}

launchPodWithCrew:

- (ShipEntity *) launchPodWithCrew:

(NSArray *)

podCrew

Extends class ShipEntity.

Definition at line 2092 of file ShipEntity.m.

                                  :(NSArray *)podCrew
{
    ShipEntity *pod = nil;
    
    pod = [UNIVERSE newShipWithRole:[shipinfoDictionary oo_stringForKey:@"escape_pod_role"]];   // or nil
    if (!pod)
    {
        //  _role not defined? it might have _model defined;
        pod = [UNIVERSE newShipWithRole:[shipinfoDictionary oo_stringForKey:@"escape_pod_model" defaultValue:@"escape-capsule"]];
        if (!pod)
        {
            pod = [UNIVERSE newShipWithRole:@"escape-capsule"];
            OOLog(@"shipEntity.noEscapePod", @"Ship %@ has no correct escape_pod_role defined. Now using default capsule.", self);
        }
    }
    
    if (pod)
    {
        [pod setOwner:self];
        [pod setTemperature:[self randomEjectaTemperatureWithMaxFactor:0.9]];
        [pod setCommodity:@"slaves" andAmount:1];
        [pod setCrew:podCrew];
        [pod switchAITo:@"oolite-shuttleAI.js"];
        [self dumpItem:pod];    // CLASS_CARGO, STATUS_IN_FLIGHT, AI state GLOBAL
        [pod release]; //release
    }
    
    return pod;
}

noteFrustration:

- (void) noteFrustration:

(NSString *)

context

Extends class ShipEntity.

Definition at line 2092 of file ShipEntity.m.

                       :(NSString *)context
{
    [shipAI reactToMessage:@"FRUSTRATED" context:context];
    [self doScriptEvent:OOJSID("shipAIFrustrated") withArgument:context];
}

refreshEscortPositions

- (void) refreshEscortPositions

Extends class ShipEntity.

Definition at line 9589 of file ShipEntity.m.

{
    if (!_escortPositionsValid)
    {
        JSContext           *context = OOJSAcquireContext();
        jsval               result;
        jsval               args[] = { INT_TO_JSVAL(0), INT_TO_JSVAL(_maxEscortCount) };
        BOOL                OK;
        
        // Reset validity first so updateEscortFormation can be called from the update callback.
        _escortPositionsValid = YES;
        
        uint8_t i;
        for (i = 0; i < _maxEscortCount; i++)
        {
            args[0] = INT_TO_JSVAL(i);
            OK = [script callMethod:OOJSID("coordinatesForEscortPosition")
                          inContext:context
                      withArguments:args count:sizeof args / sizeof *args
                             result:&result];
            
            if (OK)  OK = JSValueToVector(context, result, &_escortPositions[i]);
            
            if (!OK)  _escortPositions[i] = kZeroVector;
        }
        
        OOJSRelinquishContext(context);
    }
}

rescaleBy:

- (void) rescaleBy:

(GLfloat)

factor

Extends class ShipEntity.

Definition at line 7616 of file ShipEntity.m.

                  :(GLfloat)factor
{
    [self rescaleBy:factor writeToCache:YES];
}

rescaleBy:writeToCache:

- (void) rescaleBy:		(GLfloat)	factor
writeToCache:		(BOOL)	writeToCache

Extends class ShipEntity.

Definition at line 7616 of file ShipEntity.m.

                  :(GLfloat)factor writeToCache:(BOOL)writeToCache
{
    _scaleFactor *= factor;
    OOMesh *mesh = nil;
 
    NSDictionary *shipDict = [self shipInfoDictionary];
    NSString *modelName = [shipDict oo_stringForKey:@"model"];
    if (modelName != nil)
    {
        mesh = [OOMesh meshWithName:modelName
                           cacheKey:[NSString stringWithFormat:@"%@-%.3f",_shipKey,_scaleFactor]
                 materialDictionary:[shipDict oo_dictionaryForKey:@"materials"]
                  shadersDictionary:[shipDict oo_dictionaryForKey:@"shaders"]
                             smooth:[shipDict oo_boolForKey:@"smooth" defaultValue:NO]
                       shaderMacros:OODefaultShipShaderMacros()
                       shaderBindingTarget:self
                        scaleFactor:factor
                     cacheWriteable:writeToCache];
 
        if (mesh == nil)  return;
        [self setMesh:mesh];
    }
 
    // rescale subentities
    Entity<OOSubEntity> *se = nil;
    foreach (se, [self subEntities])
    {
        [se setPosition:HPvector_multiply_scalar([se position], factor)];
        [se rescaleBy:factor writeToCache:writeToCache];
    }
    
    // rescale mass
    mass *= factor * factor * factor;
}

setShipHitByLaser:

- (void) setShipHitByLaser:

(ShipEntity *)

ship

Extends class ShipEntity.

Definition at line 9589 of file ShipEntity.m.

                          :(ShipEntity *)ship
{
    if (ship != [self shipHitByLaser])
    {
        [_shipHitByLaser release];
        _shipHitByLaser = [ship weakRetain];
    }
}

setUpMixedEscorts

- (void) setUpMixedEscorts

Extends class ShipEntity.

Definition at line 14942 of file ShipEntity.m.

{
    NSArray *escortRoles = [shipinfoDictionary oo_arrayForKey:@"escort_roles" defaultValue:nil];
    if (escortRoles == nil)
    {
        OOLogWARN(@"eship.setUp.escortShipRoles", 
                  @"Ship %@ has bad escort_roles definition.", self);
        return;
    }
    NSDictionary                *escortDefinition = nil;
    NSDictionary        *systeminfo = nil;
    OOGovernmentID      government;
 
    systeminfo = [UNIVERSE currentSystemData];
    government = [systeminfo oo_unsignedCharForKey:KEY_GOVERNMENT];
 
    OOShipGroup *escortGroup = [self escortGroup];
    if ([self group] == nil)
    {
        [self setGroup:escortGroup]; // should probably become a copy of the escortGroup post NMSR.
    }
    [escortGroup setLeader:self];
    _maxEscortCount = MAX_ESCORTS;
    [self refreshEscortPositions];
    
    uint8_t currentEscortCount = [escortGroup count] - 1;   // always at least 0
    
    _maxEscortCount = 0;
    int8_t i = 0;
    foreach (escortDefinition, escortRoles)
    {
        if (currentEscortCount >= MAX_ESCORTS)
        {
            break;
        }
        // int rather than uint because, at least for min, there is a
        // use to giving a negative value
        int8_t min = [escortDefinition oo_intForKey:@"min" defaultValue:0];
        int8_t max = [escortDefinition oo_intForKey:@"max" defaultValue:2];
        NSString *escortRole = [escortDefinition oo_stringForKey:@"role" defaultValue:@"escort"];
        int8_t desired = max;
        if (min < desired)
        {
            for (i = min ; i < max ; i++)
            {
                if (Ranrot()%11 < government+2)
                {
                    desired--;
                }
            }
        }
        for (i = 0; i < desired; i++)
        {
            if (currentEscortCount >= MAX_ESCORTS)
            {
                break;
            }
            if (![escortRole isEqualToString:@""])
            {
                HPVector ex_pos = [self coordinatesForEscortPosition:currentEscortCount];
                ShipEntity *escorter = [UNIVERSE newShipWithRole:escortRole];   // retained
                if (escorter == nil)
                {
                    break;
                }
                [self setUpOneEscort:escorter inGroup:escortGroup withRole:escortRole atPosition:ex_pos andCount:currentEscortCount];
                [escorter release];
            }
            currentEscortCount++;
            _maxEscortCount++;
        }
    }
    // done assigning escorts
    _pendingEscortCount = 0;
}

setUpOneEscort:inGroup:withRole:atPosition:andCount:

- (void) setUpOneEscort:		(ShipEntity *)	escorter
inGroup:		(OOShipGroup *)	escortGroup
withRole:		(NSString *)	escortRole
atPosition:		(HPVector)	ex_pos
andCount:		(uint8_t)	currentEscortCount

Extends class ShipEntity.

Definition at line 14942 of file ShipEntity.m.

                       :(ShipEntity *)escorter inGroup:(OOShipGroup *)escortGroup withRole:(NSString *)escortRole atPosition:(HPVector)ex_pos andCount:(uint8_t)currentEscortCount
{
    NSString        *autoAI = nil;
    NSString        *pilotRole = nil;
    NSDictionary    *autoAIMap = nil;
    NSDictionary    *escortShipDict = nil;
    AI              *escortAI = nil; 
    NSString        *defaultRole = @"escort";
 
    if ([self isPolice])
    {
        defaultRole = @"wingman";
        pilotRole = @"police"; // police are always insured.
    }
    else
    {
        pilotRole = bounty ? @"pirate" : @"hunter"; // hunters have insurancies, pirates not.
    }
    
    double dd = escorter->collision_radius;
        
    if (EXPECT(currentEscortCount < (uint8_t)MAX_ESCORTS))
    {
        // spread them around a little randomly
        ex_pos.x += dd * 6.0 * (randf() - 0.5);
        ex_pos.y += dd * 6.0 * (randf() - 0.5);
        ex_pos.z += dd * 6.0 * (randf() - 0.5);
    }
    else
    {
        // Thargoid armada(!) Add more distance between the 'escorts'.
        ex_pos.x += dd * 12.0 * (randf() - 0.5);
        ex_pos.y += dd * 12.0 * (randf() - 0.5);
        ex_pos.z += dd * 12.0 * (randf() - 0.5);
    }
        
    [escorter setPosition:ex_pos];  // minimise lollipop flash
        
    if ([escorter crew] == nil)
    {
        [escorter setSingleCrewWithRole:pilotRole];
    }
        
    [escorter setPrimaryRole:defaultRole];  //for mothership
    // in case this hasn't yet been set, make sure escorts get a real scan class
    // shouldn't happen very often, but is possible
    if (scanClass == CLASS_NOT_SET)
    {
        scanClass = CLASS_NEUTRAL;
    }
    [escorter setScanClass:scanClass];      // you are the same as I
        
    if ([self bounty] == 0)  [escorter setBounty:0 withReason:kOOLegalStatusReasonSetup];   // Avoid dirty escorts for clean mothers
        
    // find the right autoAI.
    escortShipDict = [escorter shipInfoDictionary];
    autoAIMap = [ResourceManager dictionaryFromFilesNamed:@"autoAImap.plist" inFolder:@"Config" andMerge:YES];
    autoAI = [autoAIMap oo_stringForKey:defaultRole];
    if (autoAI==nil) // no 'wingman' defined in autoAImap?
    {
        autoAI = [autoAIMap oo_stringForKey:@"escort" defaultValue:@"nullAI.plist"];
    }
        
    escortAI = [escorter getAI];
        
    // Let the populator decide which AI to use, unless we have a working alternative AI & we specify auto_ai = NO !
    if ( (escortRole && [escortShipDict oo_fuzzyBooleanForKey:@"auto_ai" defaultValue:YES])
         || ([[escortAI name] isEqualToString: @"nullAI.plist"] && ![autoAI isEqualToString:@"nullAI.plist"]) )
    {
        [escorter switchAITo:autoAI];
    }
 
    [escorter setGroup:escortGroup];
    [escorter setOwner:self];   // mark self as group leader
 
    
    if ([self status] == STATUS_DOCKED)
    {
        [[self owner] addShipToLaunchQueue:escorter withPriority:NO];
    }
    else
    {
        [UNIVERSE addEntity:escorter];  // STATUS_IN_FLIGHT, AI state GLOBAL
        [escortAI setState:@"FLYING_ESCORT"];   // Begin escort flight. (If the AI doesn't define FLYING_ESCORT, this has no effect.)
        [escorter doScriptEvent:OOJSID("spawnedAsEscort") withArgument:self];
    }
    
    if([escorter heatInsulation] < [self heatInsulation]) [escorter setHeatInsulation:[self heatInsulation]]; // give escorts same protection as mother.
    if(([escorter maxFlightSpeed] < cruiseSpeed) && ([escorter maxFlightSpeed] > cruiseSpeed * 0.3)) 
        cruiseSpeed = [escorter maxFlightSpeed] * 0.99;  // adapt patrolSpeed to the slowest escort but ignore the very slow ones.
        
        
    if (bounty)
    {
        int extra = 1 | (ranrot_rand() & 15);
        // if mothership is offender, make sure escorter is too.
        [escorter markAsOffender:extra withReason:kOOLegalStatusReasonSetup];
    }
    else
    {
        // otherwise force the escort to be clean
        [escorter setBounty:0 withReason:kOOLegalStatusReasonSetup];
    }
    
}

setUpOneFlasher:

- (BOOL) setUpOneFlasher:

(NSDictionary *)

subentDict

Extends class ShipEntity.

Definition at line 14942 of file ShipEntity.m.

                        :(NSDictionary *) subentDict
{
    OOFlasherEntity *flasher = [OOFlasherEntity flasherWithDictionary:subentDict];
    [flasher setPosition:HPvector_multiply_scalar([subentDict oo_hpvectorForKey:@"position"],_scaleFactor)];
    [flasher rescaleBy:_scaleFactor];
    [self addSubEntity:flasher];
    return YES;
}

setUpOneSubentity:

- (BOOL) setUpOneSubentity:

(NSDictionary *)

subentDict

Extends class ShipEntity.

Definition at line 14942 of file ShipEntity.m.

                          :(NSDictionary *) subentDict
{
    OOJS_PROFILE_ENTER
    
    NSString            *type = nil;
    
    type = [subentDict oo_stringForKey:@"type"];
    if ([type isEqualToString:@"flasher"])
    {
        return [self setUpOneFlasher:subentDict];
    }
    else
    {
        return [self setUpOneStandardSubentity:subentDict asTurret:[type isEqualToString:@"ball_turret"]];
    }
    
    OOJS_PROFILE_EXIT
}

subEntityDied:

- (void) subEntityDied:

(ShipEntity *)

sub

Extends class ShipEntity.

Definition at line 7616 of file ShipEntity.m.

                     :(ShipEntity *)sub
{
    if ([self subEntityTakingDamage] == sub)  [self setSubEntityTakingDamage:nil];
    
    [sub setOwner:nil];
    // TODO? Recalculating collision radius should increase collision testing efficiency,
    // but for most ship models the difference would be marginal. -- Kaks 20110429
    mass -= [sub mass]; // missing subents affect fuel charge rate, etc..
    [subEntities removeObject:sub];
}

subEntityReallyDied:

- (void) subEntityReallyDied:

(ShipEntity *)

sub

Extends class ShipEntity.

Definition at line 7616 of file ShipEntity.m.

                           :(ShipEntity *)sub
{
    if ([self subEntityTakingDamage] == sub)  [self setSubEntityTakingDamage:nil];
    
    if ([self hasSubEntity:sub])
    {
        OOLogERR(@"shipEntity.bug.subEntityRetainUnderflow", @"Subentity of %@ died while still in subentity list! This is bad. Leaking subentity list to avoid crash. %@", self, @"This is an internal error, please report it.");
        
        // Leak subentity list.
        subEntities = nil;
    }
}

---

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

• src/Core/Entities/ShipEntity.m