ShipEntity(LoadRestore) Category Reference

#include <ShipEntityLoadRestore.h>

Instance Methods
(NSDictionary *)	- savedShipDictionaryWithContext:
(void)	- simplifyShipdata:andGetDeletes: [implementation]

Class Methods
(id)	+ shipRestoredFromDictionary:useFallback:context:

Detailed Description

Definition at line 31 of file ShipEntityLoadRestore.h.

Method Documentation

savedShipDictionaryWithContext:

- (NSDictionary *) savedShipDictionaryWithContext:

(NSMutableDictionary *)

context

Extends class ShipEntity.

Definition at line 79 of file ShipEntityLoadRestore.m.

                                                 :(NSMutableDictionary *)context
{
    NSMutableDictionary *result = [NSMutableDictionary dictionary];
    if (context == nil)  context = [NSMutableDictionary dictionary];
    
    [result setObject:_shipKey forKey:KEY_SHIP_KEY];
    
    NSMutableDictionary *updatedShipInfo = [NSMutableDictionary dictionaryWithDictionary:shipinfoDictionary];
    
    [updatedShipInfo setObject:[[self roleSet] roleString] forKey:KEY_ROLES];
    [updatedShipInfo oo_setUnsignedInteger:fuel forKey:KEY_FUEL];
    [updatedShipInfo oo_setUnsignedLongLong:bounty forKey:KEY_BOUNTY];
    [updatedShipInfo setObject:OOStringFromWeaponType(forward_weapon_type) forKey:KEY_FORWARD_WEAPON];
    [updatedShipInfo setObject:OOStringFromWeaponType(aft_weapon_type) forKey:KEY_AFT_WEAPON];
    [updatedShipInfo setObject:OOStringFromScanClass(scanClass) forKey:KEY_SCAN_CLASS];
    
    NSArray *deletes = nil;
    [self simplifyShipdata:updatedShipInfo andGetDeletes:&deletes];
    
    [result setObject:updatedShipInfo forKey:KEY_SHIPDATA_OVERRIDES];
    if (deletes != nil)  [result setObject:deletes forKey:KEY_SHIPDATA_DELETES];
    
    if (!HPvector_equal([self position], kZeroHPVector))
    {
        [result oo_setHPVector:[self position] forKey:KEY_POSITION];
    }
    if (!quaternion_equal([self normalOrientation], kIdentityQuaternion))
    {
        [result oo_setQuaternion:[self normalOrientation] forKey:KEY_ORIENTATION];
    }
    
    if (energy != maxEnergy)  [result oo_setFloat:energy / maxEnergy forKey:KEY_ENERGY_LEVEL];
    
    [result setObject:[self primaryRole] forKey:KEY_PRIMARY_ROLE];
    
    // Add equipment.
    NSArray *equipment = [[self equipmentEnumerator] allObjects];
    if ([equipment count] != 0)  [result setObject:equipment forKey:KEY_EQUIPMENT];
    
    // Add missiles.
    if (missiles > 0)
    {
        NSMutableArray *missileArray = [NSMutableArray array];
        unsigned i;
        for (i = 0; i < missiles; i++)
        {
            NSString *missileType = [missile_list[i] identifier];
            if (missileType != nil)  [missileArray addObject:missileType];
        }
        [result setObject:missileArray forKey:KEY_MISSILES];
    }
    
    // Add groups.
    if (_group != nil)
    {
        [result oo_setUnsignedInteger:GroupIDForGroup(_group, context) forKey:KEY_GROUP_ID];
        if ([_group leader] == self)  [result oo_setBool:YES forKey:KEY_IS_GROUP_LEADER];
        NSString *groupName = [_group name];
        if (groupName != nil)
        {
            [result setObject:groupName forKey:KEY_GROUP_NAME];
        }
    }
    if (_escortGroup != nil)
    {
        [result oo_setUnsignedInteger:GroupIDForGroup(_escortGroup, context) forKey:KEY_ESCORT_GROUP_ID];
    }
    /*  Eric: 
        The escortGroup property is removed from the lead ship, on entering witchspace.
        But it is needed in the save file to correctly restore an escorted group.
    */
    else if (_group != nil && [_group leader] == self)
    {
        [result oo_setUnsignedInteger:GroupIDForGroup(_group, context) forKey:KEY_ESCORT_GROUP_ID];
    }
    
    // FIXME: AI.
    // Eric: I think storing the AI name should be enough. On entering a wormhole, the stack is cleared so there are no preserved AI states.
    // Also the AI restarts itself with the GLOBAL state, so no need to store any old state. 
    if ([[[self getAI] name] isEqualToString:@"nullAI.plist"])
    {
        // might be a JS version
        [result setObject:[[self getAI] associatedJS] forKey:KEY_AI];
        // if there isn't, loading nullAI.js will load nullAI.plist anyway
    }
    else
    {
        [result setObject:[[self getAI] name] forKey:KEY_AI];
    }
    
    return result;
}

References AI::associatedJS, count, ShipEntity::equipmentEnumerator, ShipEntity::getAI, kIdentityQuaternion, kZeroHPVector, AI::name, nil, Entity::normalOrientation, Entity::position, ShipEntity::primaryRole, ShipEntity::roleSet, OORoleSet::roleString, and ShipEntity::simplifyShipdata:andGetDeletes:.

Here is the call graph for this function:

shipRestoredFromDictionary:useFallback:context:

+ (id) shipRestoredFromDictionary:		(NSDictionary *)	dictionary
useFallback:		(BOOL)	fallback
context:		(NSMutableDictionary *)	context

Extends class ShipEntity.

Definition at line 173 of file ShipEntityLoadRestore.m.

                                 :(NSDictionary *)dict
                      useFallback:(BOOL)fallback
                          context:(NSMutableDictionary *)context
{
    if (dict == nil)  return nil;
    if (context == nil)  context = [NSMutableDictionary dictionary];
    
    ShipEntity *ship = nil;
    
    NSString *shipKey = [dict oo_stringForKey:KEY_SHIP_KEY];
    NSDictionary *shipData = [[OOShipRegistry sharedRegistry] shipInfoForKey:shipKey];
    
    if (shipData != nil)
    {
        NSMutableDictionary *mergedData = [NSMutableDictionary dictionaryWithDictionary:shipData];
        
        StripIgnoredKeys(mergedData);
        NSArray *deletes = [dict oo_arrayForKey:KEY_SHIPDATA_DELETES];
        if (deletes != nil)  [mergedData removeObjectsForKeys:deletes];
        [mergedData addEntriesFromDictionary:[dict oo_dictionaryForKey:KEY_SHIPDATA_OVERRIDES]];
        [mergedData oo_setBool:NO forKey:@"auto_ai"];
        [mergedData oo_setUnsignedInteger:0 forKey:@"escorts"];
        
        Class shipClass = [UNIVERSE shipClassForShipDictionary:mergedData];
        ship = [[[shipClass alloc] initWithKey:shipKey definition:mergedData] autorelease];
        
        // FIXME: restore AI.
        [ship setAITo:[dict oo_stringForKey:KEY_AI defaultValue:@"nullAI.plist"]];
        
        [ship setPrimaryRole:[dict oo_stringForKey:KEY_PRIMARY_ROLE]];
    
    }
    else
    {
        // Unknown ship; fall back on role if desired and possible.
        NSString *shipPrimaryRole = [dict oo_stringForKey:KEY_PRIMARY_ROLE];
        if (!fallback || shipPrimaryRole == nil)  return nil;
        
        ship = [[UNIVERSE newShipWithRole:shipPrimaryRole] autorelease];
        if (ship == nil)  return nil;
    }
    
    // The following stuff is deliberately set up the same way even if using role fallback.
    [ship setPosition:[dict oo_hpvectorForKey:KEY_POSITION]];
    [ship setNormalOrientation:[dict oo_quaternionForKey:KEY_ORIENTATION]];
    
    float energyLevel = [dict oo_floatForKey:KEY_ENERGY_LEVEL defaultValue:1.0f];
    [ship setEnergy:energyLevel * [ship maxEnergy]];
    
    [ship removeAllEquipment];
    NSEnumerator *eqEnum = nil;
    NSString *eqKey = nil;
    for (eqEnum = [[dict oo_arrayForKey:KEY_EQUIPMENT] objectEnumerator]; (eqKey = [eqEnum nextObject]); )
    {
        [ship addEquipmentItem:eqKey withValidation:NO inContext:@"loading"];
    }
    
    [ship removeMissiles];
    for (eqEnum = [[dict oo_arrayForKey:KEY_MISSILES] objectEnumerator]; (eqKey = [eqEnum nextObject]); )
    {
        [ship addEquipmentItem:eqKey withValidation:NO inContext:@"loading"];
    }
    
    // Groups.
    NSUInteger groupID = [dict oo_integerForKey:KEY_GROUP_ID defaultValue:NSNotFound];
    if (groupID != NSNotFound)
    {
        OOShipGroup *group = GroupForGroupID(groupID, context);
        [ship setGroup:group];  // Handles adding to group
        if ([dict oo_boolForKey:KEY_IS_GROUP_LEADER])  [group setLeader:ship];
        NSString *groupName = [dict oo_stringForKey:KEY_GROUP_NAME];
        if (groupName != nil)  [group setName:groupName];
        if ([ship hasPrimaryRole:@"escort"] && ship != [group leader])
        {
            [ship setOwner:[group leader]];
        }
    }
    
    groupID = [dict oo_integerForKey:KEY_ESCORT_GROUP_ID defaultValue:NSNotFound];
    if (groupID != NSNotFound)
    {
        OOShipGroup *group = GroupForGroupID(groupID, context);
        [group setLeader:ship];
        [group setName:@"escort group"];
        [ship setEscortGroup:group];
    }
    
    return ship;
}

References ShipEntity::addEquipmentItem:withValidation:inContext:, GroupForGroupID(), KEY_EQUIPMENT, KEY_IS_GROUP_LEADER, KEY_MISSILES, OOShipGroup::leader, Entity::maxEnergy, nil, ShipEntity::removeAllEquipment, ShipEntity::removeMissiles, ShipEntity::setAITo:, Entity::setEnergy:, ShipEntity::setEscortGroup:, ShipEntity::setGroup:, OOShipGroup::setLeader:, OOShipGroup::setName:, Entity::setNormalOrientation:, ShipEntity::setOwner:, Entity::setPosition:, ShipEntity::setPrimaryRole:, OOShipRegistry::sharedRegistry, OOShipRegistry::shipInfoForKey:, and StripIgnoredKeys().

Here is the call graph for this function:

simplifyShipdata:andGetDeletes:

- (void) simplifyShipdata: (NSMutableDictionary *) data andGetDeletes: (NSArray **) deletes

implementation

Extends class ShipEntity.

Definition at line 264 of file ShipEntityLoadRestore.m.

                         :(NSMutableDictionary *)data andGetDeletes:(NSArray **)deletes
{
    NSParameterAssert(data != nil && deletes != NULL);
    *deletes = nil;
    
    // Get original ship data.
    NSMutableDictionary *referenceData = [NSMutableDictionary dictionaryWithDictionary:[[OOShipRegistry sharedRegistry] shipInfoForKey:[self shipDataKey]]];
    
    // Discard stuff that we handle separately.
    StripIgnoredKeys(referenceData);
    StripIgnoredKeys(data);
    
    // Note items that are in referenceData, but not data.
    NSMutableArray *foundDeletes = [NSMutableArray array];
    NSEnumerator *enumerator = nil;
    NSString *key = nil;
    for (enumerator = [referenceData keyEnumerator]; (key = [enumerator nextObject]); )
    {
        if ([data objectForKey:key] == nil)
        {
            [foundDeletes addObject:key];
        }
    }
    if ([foundDeletes count] != 0)  *deletes = foundDeletes;
    
    // after rev3010 this loop was using cycles without doing anything - commenting this whole loop out for now. -- kaks 20100207
/*
    // Discard anything that hasn't changed.
    for (enumerator = [data keyEnumerator]; (key = [enumerator nextObject]); )
    {
        id referenceVal = [referenceData objectForKey:key];
        id myVal = [data objectForKey:key];
        if ([referenceVal isEqual:myVal])
        {
        //  [data removeObjectForKey:key];
        }
    }
*/
}

---

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

• src/Core/Entities/ShipEntityLoadRestore.h
• src/Core/Entities/ShipEntityLoadRestore.m