OOCommodities(OOPrivate) Category Reference

Instance Methods
(NSDictionary *)	- modifyGood:withScript:atStation:inSystem:localMode:
(NSDictionary *)	- createDefinitionFrom:price:andQuantity:forKey:atStation:inSystem:
(OOCargoQuantity)	- generateQuantityForGood:inEconomy:
(OOCreditsQuantity)	- generatePriceForGood:inEconomy:
(float)	- economicBiasForGood:inEconomy:
(NSDictionary *)	- firstModifierForGood:inClasses:fromList:
(OOCreditsQuantity)	- adjustPrice:byRule:
(OOCargoQuantity)	- adjustQuantity:byRule:
(NSDictionary *)	- updateInfoFor:byRule:maxCapacity:

Detailed Description

Definition at line 36 of file OOCommodities.m.

Method Documentation

adjustPrice:byRule:

- (OOCreditsQuantity) adjustPrice:		(OOCreditsQuantity)	price
byRule:		(NSDictionary *)	rule

Extends class OOCommodities.

Definition at line 1 of file OOCommodities.m.

                                 :(OOCreditsQuantity)price byRule:(NSDictionary *)rule
{
    float p = (float)price; // work in floats to avoid rounding problems
    float pa = [rule oo_floatForKey:kOOCommodityMarketPriceAdder defaultValue:0.0];
    float pm = [rule oo_floatForKey:kOOCommodityMarketPriceMultiplier defaultValue:1.0];
    if (pm <= 0.0 && pa <= 0.0)
    {
        // setting a price multiplier of 0 forces the price to zero
        return 0;
    }
    float pr = [rule oo_floatForKey:kOOCommodityMarketPriceRandomiser defaultValue:0.0];
    p += pa;
    p = (p * pm) + (p * pr * (randf()-randf()));
    if (p < 1.0)
    {
        // random variation and non-zero price multiplier can't reduce
        // price below 1 decicredit
        p = 1.0;
    }
    return (OOCreditsQuantity) p;
}

adjustQuantity:byRule:

- (OOCargoQuantity) adjustQuantity:		(OOCargoQuantity)	quantity
byRule:		(NSDictionary *)	rule

Extends class OOCommodities.

Definition at line 1 of file OOCommodities.m.

                                  :(OOCargoQuantity)quantity byRule:(NSDictionary *)rule
{
    float q = (float)quantity; // work in floats to avoid rounding problems
    float qa = [rule oo_floatForKey:kOOCommodityMarketQuantityAdder defaultValue:0.0];
    float qm = [rule oo_floatForKey:kOOCommodityMarketQuantityMultiplier defaultValue:1.0];
    if (qm <= 0.0 && qa <= 0.0)
    {
        // setting a price multiplier of 0 forces the price to zero
        return 0;
    }
    float qr = [rule oo_floatForKey:kOOCommodityMarketQuantityRandomiser defaultValue:0.0];
    q += qa;
    q = (q * qm) + (q * qr * (randf()-randf()));
    if (q < 0.0)
    {
        // random variation and non-zero price multiplier can't reduce
        // quantity below zero
        q = 0.0;
    }
    // may be over station capacity - that gets capped later
    return (OOCargoQuantity) q;
}

createDefinitionFrom:price:andQuantity:forKey:atStation:inSystem:

- (NSDictionary *) createDefinitionFrom:		(NSDictionary *)	good
price:		(OOCreditsQuantity)	p
andQuantity:		(OOCargoQuantity)	q
forKey:		(OOCommodityType)	key
atStation:		(StationEntity *)	station
inSystem:		(OOSystemID)	system

Extends class OOCommodities.

Definition at line 1 of file OOCommodities.m.

                                       :(NSDictionary *) good price:(OOCreditsQuantity)p andQuantity:(OOCargoQuantity)q forKey:(OOCommodityType)key atStation:(StationEntity *)station inSystem:(OOSystemID)system
{
    NSMutableDictionary *definition = [NSMutableDictionary dictionaryWithDictionary:good];
    [definition oo_setUnsignedInteger:p forKey:kOOCommodityPriceCurrent];
    [definition oo_setUnsignedInteger:q forKey:kOOCommodityQuantityCurrent];
    if (station == nil && [definition objectForKey:kOOCommodityCapacity] == nil)
    {
        [definition oo_setInteger:MAIN_SYSTEM_MARKET_LIMIT forKey:kOOCommodityCapacity];
    }
 
    [definition setObject:key forKey:kOOCommodityKey];
    if (station != nil && ![station marketMonitored])
    {
        // clear legal status indicators if the market is not monitored
        [definition oo_setUnsignedInteger:0 forKey:kOOCommodityLegalityExport];     
        [definition oo_setUnsignedInteger:0 forKey:kOOCommodityLegalityImport];
    }
 
    NSString *goodScriptName = [definition oo_stringForKey:kOOCommodityScript];
    if (goodScriptName == nil)
    {
        return definition;
    }
    OOScript *goodScript = [PLAYER commodityScriptNamed:goodScriptName];
    if (goodScript == nil)
    {
        return definition;
    }
    return [self modifyGood:definition withScript:goodScript atStation:station inSystem:system localMode:NO];
}

economicBiasForGood:inEconomy:

- (float) economicBiasForGood:		(NSDictionary *)	good
inEconomy:		(OOEconomyID)	economy

Extends class OOCommodities.

Definition at line 1 of file OOCommodities.m.

                             :(NSDictionary *)good inEconomy:(OOEconomyID)economy
{
    OOEconomyID exporter = [good oo_intForKey:kOOCommodityPeakExport];
    OOEconomyID importer = [good oo_intForKey:kOOCommodityPeakImport];
    
    // *2 and /2 to work in ints at this stage
    int exDiff = abs(economy-exporter)*2;
    int imDiff = abs(economy-importer)*2;
    int distance = (exDiff+imDiff)/2;
 
    if (exDiff == imDiff)
    {
        // neutral economy
        return 0.0;
    }
    else if (exDiff > imDiff)
    {
        // closer to the importer, so return -ve
        return -(1.0-((float)imDiff/(float)distance));
    }
    else
    {
        // closer to the exporter, so return +ve
        return 1.0-((float)exDiff/(float)distance);
    }
}

firstModifierForGood:inClasses:fromList:

- (NSDictionary *) firstModifierForGood:		(OOCommodityType)	good
inClasses:		(NSArray *)	classes
fromList:		(NSArray *)	definitions

Extends class OOCommodities.

Definition at line 1 of file OOCommodities.m.

                                       :(OOCommodityType)good inClasses:(NSArray *)classes fromList:(NSArray *)definitions
{
    NSUInteger i;
    for (i = 0; i < [definitions count]; i++)
    {
        NSDictionary *definition = [definitions oo_dictionaryAtIndex:i];
        if (definition != nil)
        {
            NSString *applicationType = [definition oo_stringForKey:kOOCommodityMarketType defaultValue:kOOCommodityMarketTypeValueDefault];
            NSString *applicationName = [definition oo_stringForKey:kOOCommodityMarketName defaultValue:@""];
 
            if (
                [applicationType isEqualToString:kOOCommodityMarketTypeValueDefault]
                || ([applicationType isEqualToString:kOOCommodityMarketTypeValueGood] && [applicationName isEqualToString:good])
                || ([applicationType isEqualToString:kOOCommodityMarketTypeValueClass] && [classes containsObject:applicationName])
                )
            {
                return definition;
            }
        }
    }
    // return a blank dictionary - default values will do the rest
    return [NSDictionary dictionary];
}

generatePriceForGood:inEconomy:

- (OOCreditsQuantity) generatePriceForGood:		(NSDictionary *)	good
inEconomy:		(OOEconomyID)	economy

Extends class OOCommodities.

Definition at line 1 of file OOCommodities.m.

                                          :(NSDictionary *)good inEconomy:(OOEconomyID)economy
{
    float bias = [self economicBiasForGood:good inEconomy:economy];
 
    float base = [good oo_floatForKey:kOOCommodityPriceAverage];
    float econ = base * [good oo_floatForKey:kOOCommodityPriceEconomic] * -bias;
    float random = base * [good oo_floatForKey:kOOCommodityPriceRandom] * (randf() - randf());
    base += econ + random;
    if (base < 0.0)
    {
        return 0;
    }
    else
    {
        return (OOCreditsQuantity)base;
    }
}

generateQuantityForGood:inEconomy:

- (OOCargoQuantity) generateQuantityForGood:		(NSDictionary *)	good
inEconomy:		(OOEconomyID)	economy

Extends class OOCommodities.

Definition at line 1 of file OOCommodities.m.

                                           :(NSDictionary *)good inEconomy:(OOEconomyID)economy
{
    float bias = [self economicBiasForGood:good inEconomy:economy];
 
    float base = [good oo_floatForKey:kOOCommodityQuantityAverage];
    float econ = base * [good oo_floatForKey:kOOCommodityQuantityEconomic] * bias;
    float random = base * [good oo_floatForKey:kOOCommodityQuantityRandom] * (randf() - randf());
    base += econ + random;
    if (base < 0.0)
    {
        return 0;
    }
    else
    {
        return (OOCargoQuantity)base;
    }
}

modifyGood:withScript:atStation:inSystem:localMode:

- (NSDictionary *) modifyGood:		(NSDictionary *)	good
withScript:		(OOScript *)	script
atStation:		(StationEntity *)	station
inSystem:		(OOSystemID)	system
localMode:		(BOOL)	local

Extends class OOCommodities.

Definition at line 1 of file OOCommodities.m.

                             :(NSDictionary *)good withScript:(OOScript *)script atStation:(StationEntity *)station inSystem:(OOSystemID)system localMode:(BOOL)localMode
{
    NSDictionary        *result = nil;
    JSContext           *context = OOJSAcquireContext();
    jsval               rval;
    jsval               args[] = { 
        OOJSValueFromNativeObject(context, good),
        OOJSValueFromNativeObject(context, station),
        INT_TO_JSVAL(system) 
    };
    BOOL                OK = YES;
    NSString            *errorType = nil;
 
    if (localMode)
    {
        errorType = @"local";
        OK = [script callMethod:OOJSID("updateLocalCommodityDefinition")
                      inContext:context
                  withArguments:args
                          count:3
                         result:&rval];
    }
    else
    {
        errorType = @"general";
        OK = [script callMethod:OOJSID("updateGeneralCommodityDefinition")
                      inContext:context
                  withArguments:args
                          count:3
                         result:&rval];
    }
 
    if (!OK)
    {
        OOLog(@"script.commodityScript.error",@"Could not update %@ commodity definition for %@ - unable to call updateLocalCommodityDefinition",errorType,[good oo_stringForKey:kOOCommodityName]);
        OOJSRelinquishContext(context);
        return good;
    }
 
    if (!JSVAL_IS_OBJECT(rval))
    {
        OOLog(@"script.commodityScript.error",@"Could not update %@ commodity definition for %@ - return value invalid",errorType,[good oo_stringForKey:kOOCommodityKey]);
        OOJSRelinquishContext(context);
        return good;
    }
 
    result = OOJSNativeObjectFromJSObject(context, JSVAL_TO_OBJECT(rval));
    OOJSRelinquishContext(context);
    if (![result isKindOfClass:[NSDictionary class]])
    {
        OOLog(@"script.commodityScript.error",@"Could not update %@ commodity definition for %@ - return value invalid",errorType,[good oo_stringForKey:kOOCommodityKey]);
        return good;
    }
    
    return result;
}

updateInfoFor:byRule:maxCapacity:

- (NSDictionary *) updateInfoFor:		(NSDictionary *)	good
byRule:		(NSDictionary *)	rule
maxCapacity:		(OOCargoQuantity)	maxCapacity

Extends class OOCommodities.

Definition at line 1 of file OOCommodities.m.

                                :(NSDictionary *)good byRule:(NSDictionary *)rule maxCapacity:(OOCargoQuantity)maxCapacity
{
    NSMutableDictionary *tmp = [NSMutableDictionary dictionaryWithDictionary:good];
    NSInteger import = [rule oo_integerForKey:kOOCommodityMarketLegalityImport defaultValue:-1];
    if (import >= 0)
    {
        [tmp oo_setInteger:import forKey:kOOCommodityLegalityImport];
    }
 
    NSInteger export = [rule oo_integerForKey:kOOCommodityMarketLegalityExport defaultValue:-1];
    if (export >= 0)
    {
        [tmp oo_setInteger:import forKey:kOOCommodityLegalityExport];
    }
 
    NSInteger capacity = [rule oo_integerForKey:kOOCommodityMarketCapacity defaultValue:-1];
    if (capacity >= 0 && capacity <= (NSInteger)maxCapacity)
    {
        [tmp oo_setInteger:capacity forKey:kOOCommodityCapacity];
    }
    else
    {
        // set to the station max capacity
        [tmp oo_setInteger:maxCapacity forKey:kOOCommodityCapacity];
    }
 
    return [[tmp copy] autorelease];
}

---

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

• src/Core/OOCommodities.m