OOEquipmentType(Private) Category Reference

Instance Methods
(id)	- initWithInfo:

Detailed Description

Definition at line 43 of file OOEquipmentType.m.

Method Documentation

initWithInfo:

- (id) initWithInfo:

(NSArray *)

info

Extends class OOEquipmentType.

Definition at line 40 of file OOEquipmentType.m.

                   :(NSArray *)info
{
    BOOL                OK = YES;
    NSDictionary        *extra = nil;
    NSArray             *conditions = nil;
    NSString            *condition_script = nil;
    NSArray             *keydef = nil;
 
    self = [super init];
    if (self == nil)  OK = NO;
    
    if (OK && [info count] <= EQUIPMENT_LONG_DESC_INDEX)  OK = NO;
    
    if (OK)
    {
        // Read required attributes
        _techLevel = [info oo_unsignedIntAtIndex:EQUIPMENT_TECH_LEVEL_INDEX];
        _price = [info oo_unsignedIntAtIndex:EQUIPMENT_PRICE_INDEX];
        _name = [[info oo_stringAtIndex:EQUIPMENT_SHORT_DESC_INDEX] retain];
        _identifier = [[info oo_stringAtIndex:EQUIPMENT_KEY_INDEX] retain];
        _description = [[info oo_stringAtIndex:EQUIPMENT_LONG_DESC_INDEX] retain];
        
        if (_name == nil || _identifier == nil || _description == nil)
        {
            OOLog(@"equipment.load", @"***** ERROR: Invalid equipment.plist entry - missing name, identifier or description (\"%@\", %@, \"%@\")", _name, _identifier, _description);
            OK = NO;
        }
    }
    
    if (OK)
    {
        // Implied attributes for backwards-compatibility
        if ([_identifier hasSuffix:@"_MISSILE"] || [_identifier hasSuffix:@"_MINE"])
        {
            _isMissileOrMine = YES;
            _requiresEmptyPylon = YES;
        }
        else if ([_identifier isEqualToString:@"EQ_PASSENGER_BERTH_REMOVAL"])
        {
            _requiresFreePassengerBerth = YES;
        }
        else if ([_identifier isEqualToString:@"EQ_FUEL"])
        {
            _requiresNonFullFuel = YES;
        }
        _isVisible = YES;
        _isAvailableToPlayer = YES;
        _isAvailableToNPCs = YES;
        _damageProbability = 1.0;
        _hideValues = NO;
    }
    
    if (OK && [info count] > EQUIPMENT_EXTRA_INFO_INDEX)
    {
        // Read extra info dictionary
        extra = [info oo_dictionaryAtIndex:EQUIPMENT_EXTRA_INFO_INDEX];
        if (extra != nil)
        {
            
            _isAvailableToAll = [extra oo_boolForKey:@"available_to_all" defaultValue:_isAvailableToAll];
            _isAvailableToPlayer = [extra oo_boolForKey:@"available_to_player" defaultValue:_isAvailableToPlayer];
            _isAvailableToNPCs = [extra oo_boolForKey:@"available_to_NPCs" defaultValue:_isAvailableToNPCs];
            
            _isMissileOrMine = [extra oo_boolForKey:@"is_external_store" defaultValue:_isMissileOrMine];
            _requiresEmptyPylon = [extra oo_boolForKey:@"requires_empty_pylon" defaultValue:_requiresEmptyPylon];
            _requiresMountedPylon = [extra oo_boolForKey:@"requires_mounted_pylon" defaultValue:_requiresMountedPylon];
            _requiresClean = [extra oo_boolForKey:@"requires_clean" defaultValue:_requiresClean];
            _requiresNotClean = [extra oo_boolForKey:@"requires_not_clean" defaultValue:_requiresNotClean];
            _portableBetweenShips = [extra oo_boolForKey:@"portable_between_ships" defaultValue:_portableBetweenShips];
            _requiresFreePassengerBerth = [extra oo_boolForKey:@"requires_free_passenger_berth" defaultValue:_requiresFreePassengerBerth];
            _requiresFullFuel = [extra oo_boolForKey:@"requires_full_fuel" defaultValue:_requiresFullFuel];
            _requiresNonFullFuel = [extra oo_boolForKey:@"requires_non_full_fuel" defaultValue:_requiresNonFullFuel];
            _isVisible = [extra oo_boolForKey:@"visible" defaultValue:_isVisible];
            _canCarryMultiple = [extra oo_boolForKey:@"can_carry_multiple" defaultValue:NO];
            _hideValues = [extra oo_boolForKey:@"hide_values" defaultValue:NO];
 
            _requiredCargoSpace = [extra oo_unsignedIntForKey:@"requires_cargo_space" defaultValue:_requiredCargoSpace];
 
            _installTime = [extra oo_unsignedIntForKey:@"installation_time" defaultValue:0];
            _repairTime = [extra oo_unsignedIntForKey:@"repair_time" defaultValue:0];
            _provides = [[extra oo_arrayForKey:@"provides" defaultValue:[NSArray array]] retain];
 
            id dispColor = [extra oo_objectForKey:@"display_color" defaultValue:nil];
            _displayColor = [[OOColor colorWithDescription:dispColor] retain];
 
            _weaponInfo = [[extra oo_dictionaryForKey:@"weapon_info" defaultValue:[NSDictionary dictionary]] retain];
 
            _damageProbability = [extra oo_floatForKey:@"damage_probability" defaultValue:(_isMissileOrMine?0.0:1.0)];
            
            id object = [extra objectForKey:@"requires_equipment"];
            if ([object isKindOfClass:[NSString class]])  _requiresEquipment = [[NSSet setWithObject:object] retain];
            else if ([object isKindOfClass:[NSArray class]])  _requiresEquipment = [[NSSet setWithArray:object] retain];
            else if (object != nil)
            {
                OOLog(@"equipment.load", @"***** ERROR: %@ for equipment item %@ is not a string or an array.", @"requires_equipment", _identifier);
            }
            
            object = [extra objectForKey:@"requires_any_equipment"];
            if ([object isKindOfClass:[NSString class]])  _requiresAnyEquipment = [[NSSet setWithObject:object] retain];
            else if ([object isKindOfClass:[NSArray class]])  _requiresAnyEquipment = [[NSSet setWithArray:object] retain];
            else if (object != nil)
            {
                OOLog(@"equipment.load", @"***** ERROR: %@ for equipment item %@ is not a string or an array.", @"requires_any_equipment", _identifier);
            }
            
            object = [extra objectForKey:@"incompatible_with_equipment"];
            if ([object isKindOfClass:[NSString class]])  _incompatibleEquipment = [[NSSet setWithObject:object] retain];
            else if ([object isKindOfClass:[NSArray class]])  _incompatibleEquipment = [[NSSet setWithArray:object] retain];
            else if (object != nil)
            {
                OOLog(@"equipment.load", @"***** ERROR: %@ for equipment item %@ is not a string or an array.", @"incompatible_with_equipment", _identifier);
            }
            
            object = [extra objectForKey:@"conditions"];
            if ([object isKindOfClass:[NSString class]])  conditions = [NSArray arrayWithObject:object];
            else if ([object isKindOfClass:[NSArray class]])  conditions = object;
            else if (object != nil)
            {
                OOLog(@"equipment.load", @"***** ERROR: %@ for equipment item %@ is not a string or an array.", @"conditions", _identifier);
            }
            if (conditions != nil)
            {
                OOStandardsDeprecated([NSString stringWithFormat:@"The conditions key is deprecated for equipment %@",_name]);
                if (!OOEnforceStandards())
                {
                    _conditions = OOSanitizeLegacyScriptConditions(conditions, [NSString stringWithFormat:@"<equipment type \"%@\">", _name]);
                    [_conditions retain];
                }
            }
 
            object = [extra objectForKey:@"condition_script"];
            if ([object isKindOfClass:[NSString class]])
            {
                condition_script = object;
            }
            else if (object != nil)
            {
                OOLog(@"equipment.load", @"***** ERROR: %@ for equipment item %@ is not a string.", @"condition_script", _identifier);
            }
            if (condition_script != nil)
            {
                _condition_script = [condition_script retain];
            }
            /* Condition scripts are shared: all equipment/ships using the
             * same condition script use one shared instance. Equipment
             * scripts and ship scripts are not shared and get one instance
             * per item. */
            
            _scriptInfo = [extra oo_dictionaryForKey:@"script_info"];
            [_scriptInfo retain];
            
            _script = [extra oo_stringForKey:@"script"];
            if (_script != nil && ![OOScript jsScriptFromFileNamed:_script properties:nil])  _script = nil;
            [_script retain];
            if (_script != nil)
            {
                _fastAffinityA = !![extra oo_boolForKey:@"fast_affinity_defensive"];
                _fastAffinityB = !![extra oo_boolForKey:@"fast_affinity_offensive"];
 
                // look for default activate and mode key settings
                // note: the customEquipmentActivation array is only populated when starting a game
                // so the application of any default key settings on equipment will only happen then
                NSString *checking;
 
                object = [extra objectForKey:@"default_activate_key"];
                if ([object isKindOfClass:[NSArray class]]) keydef = object;
                else if (object != nil)
                {
                    OOLog(@"equipment.load", @"***** ERROR: %@ for equipment item %@ is not an array.", @"default_activate_key", _identifier);
                    object = nil;
                }
 
                if (object != nil) 
                {
                    // do processing for key
                    _defaultActivateKey = [PLAYER processKeyCode:keydef];
                    checking = [PLAYER validateKey:[NSString stringWithFormat:@"activate_%@", _identifier] checkKeys:_defaultActivateKey];
                    
                    if (checking != nil) {
                        OOLog(@"equipment.load", @"***** Error: %@ for equipment item %@ is already in use for %@. Default not applied", @"default_activate_key", _identifier, checking);
                        _defaultActivateKey = nil;
                    } 
                }
 
                object = [extra objectForKey:@"default_mode_key"];
                if ([object isKindOfClass:[NSArray class]]) keydef = object;
                else if (object != nil)
                {
                    OOLog(@"equipment.load", @"***** ERROR: %@ for equipment item %@ is not an array.", @"default_mode_key", _identifier);
                    object = nil;
                }
 
                if (object != nil) 
                {
                    // do processing for key
                    _defaultModeKey = [PLAYER processKeyCode:keydef];
                    checking = [PLAYER validateKey:[NSString stringWithFormat:@"mode_%@", _identifier] checkKeys:_defaultModeKey];
                    
                    if (checking != nil) {
                        OOLog(@"equipment.load", @"***** Error: %@ for equipment item %@ is already in use for %@. Default not applied.", @"default_mode_key", _identifier, checking);
                        _defaultModeKey = nil;
                    } 
                }
            }
        }
    }
    
    if (!OK)
    {
        [self release];
        self = nil;
    }
    return self;
}

---

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

• src/Core/OOEquipmentType.m