PlayerEntity(ScriptingPrivate) Category Reference

Instance Methods
(BOOL)	- scriptTestCondition:
(NSString *)	- expandScriptRightHandSide:
(void)	- scriptActions:forTarget:missionKey:
(NSString *)	- expandMessage:

Detailed Description

Definition at line 105 of file PlayerEntityLegacyScriptEngine.m.

Method Documentation

expandMessage:

- (NSString *) expandMessage:

(NSString *)

valueString

Extends class PlayerEntity.

Definition at line 955 of file PlayerEntityLegacyScriptEngine.m.

                            :(NSString *)valueString
{
    Random_Seed very_random_seed;
    very_random_seed.a = rand() & 255;
    very_random_seed.b = rand() & 255;
    very_random_seed.c = rand() & 255;
    very_random_seed.d = rand() & 255;
    very_random_seed.e = rand() & 255;
    very_random_seed.f = rand() & 255;
    seed_RNG_only_for_planet_description(very_random_seed);
    NSString* expandedMessage = OOExpand(valueString);
    return [self replaceVariablesInString: expandedMessage];
}

expandScriptRightHandSide:

- (NSString *) expandScriptRightHandSide:

(NSArray *)

rhsComponents

Extends class PlayerEntity.

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                                        :(NSArray *)rhsComponents
{
    NSMutableArray          *result = nil;
    NSEnumerator            *componentEnum = nil;
    NSArray                 *component = nil;
    NSString                *value = nil;
    
    result = [NSMutableArray arrayWithCapacity:[rhsComponents count]];
    
    for (componentEnum = [rhsComponents objectEnumerator]; (component = [componentEnum nextObject]); )
    {
        /*  Each component is a two-element array. The second element is a
            string. The first element is a boolean indicating whether the
            string is a selector (true) or a literal (false).
            
            All valid selectors return a string or an NSNumber; in either
            case, -description gives us a useful value to substitute into
            the expanded string.
        */
        
        value = [component oo_stringAtIndex:1];
        
        if ([[component objectAtIndex:0] boolValue])
        {
            value = [[self performSelector:NSSelectorFromString(value)] description];
            if (value == nil)  value = @"(null)";   // for backwards compatibility
        }
        
        [result addObject:value];
    }
    
    return [result componentsJoinedByString:@" "];
}

scriptActions:forTarget:missionKey:

- (void) scriptActions:		(NSArray *)	actions
forTarget:		(ShipEntity *)	target
missionKey:		(NSString *)	missionKey

Extends class PlayerEntity.

References COMPARISON_EQUAL, COMPARISON_GREATERTHAN, COMPARISON_LESSTHAN, COMPARISON_NOTEQUAL, COMPARISON_ONEOF, and COMPARISON_UNDEFINED.

scriptTestCondition:

- (BOOL) scriptTestCondition:

(NSArray *)

scriptCondition

Extends class PlayerEntity.

Definition at line 278 of file PlayerEntityLegacyScriptEngine.m.

                            :(NSArray *)scriptCondition
{
    /*  Test a script condition sanitized by OOLegacyScriptWhitelist.
        
        A sanitized condition is an array of the form:
            (opType, rawString, selector, comparisonType, operandArray).
        
        opType and comparisonType are NSNumbers containing OOOperationType and
        OOComparisonType enumerators, respectively.
        
        rawString is the original textual representation of the condition for
        display purposes.
        
        selector is a string, either a method selector or a mission/local
        variable name.
        
        operandArray is an array of operands. Each operand is itself an array
        of two items: a boolean indicating whether it's a method selector
        (true) or a literal string (false), and a string.
        
        The special opType OP_FALSE doesn't require any other elements in the
        array. All other valid opTypes require the array to have five elements.
        
        For performance reasons, this method assumes the script condition will
        have been generated by OOSanitizeLegacyScriptConditions() and doesn't
        perform extensive validity checks.
    */
    
    OOOperationType             opType;
    NSString                    *selectorString = nil;
    SEL                         selector = NULL;
    OOComparisonType            comparator;
    NSArray                     *operandArray = nil;
    NSString                    *lhsString = nil;
    NSString                    *expandedRHS = nil;
    NSArray                     *rhsComponents = nil;
    NSString                    *rhsItem = nil;
    NSUInteger                  i, count;
    NSCharacterSet              *whitespace = nil;
    double                      lhsValue, rhsValue;
    BOOL                        lhsFlag, rhsFlag;
    
    opType = [scriptCondition oo_unsignedIntAtIndex:0];
    if (opType == OP_FALSE)  return NO;
    
    selectorString = [scriptCondition oo_stringAtIndex:2];
    comparator = [scriptCondition oo_unsignedIntAtIndex:3];
    operandArray = [scriptCondition oo_arrayAtIndex:4];
    
    // Transform mission/local var ops into string ops.
    if (opType == OP_MISSION_VAR)
    {
        sMissionStringValue = [mission_variables objectForKey:selectorString];
        selector = @selector(mission_string);
        opType = OP_STRING;
    }
    else if (opType == OP_LOCAL_VAR)
    {
        sMissionStringValue = [[self localVariablesForMission:sCurrentMissionKey] objectForKey:selectorString];
        selector = @selector(mission_string);
        opType = OP_STRING;
    }
    else
    {
        selector = NSSelectorFromString(selectorString);
    }
    
    expandedRHS = [self expandScriptRightHandSide:operandArray];
    
    if (opType == OP_STRING)
    {
        lhsString = [self performSelector:selector];
        
    #define DOUBLEVAL(x) ((x != nil) ? [x doubleValue] : 0.0)
        
        switch (comparator)
        {
            case COMPARISON_UNDEFINED:
                return lhsString == nil;
                
            case COMPARISON_EQUAL:
                return [lhsString isEqualToString:expandedRHS];
                
            case COMPARISON_NOTEQUAL:
                return ![lhsString isEqualToString:expandedRHS];
                
            case COMPARISON_LESSTHAN:
                return DOUBLEVAL(lhsString) < DOUBLEVAL(expandedRHS);
                
            case COMPARISON_GREATERTHAN:
                return DOUBLEVAL(lhsString) > DOUBLEVAL(expandedRHS);
                
            case COMPARISON_ONEOF:
                {
                    rhsComponents = [expandedRHS componentsSeparatedByString:@","];
                    count = [rhsComponents count];
                    
                    whitespace = [NSCharacterSet whitespaceCharacterSet];
                    lhsString = [lhsString stringByTrimmingCharactersInSet:whitespace];
                    
                    for (i = 0; i < count; i++)
                    {
                        rhsItem = [[rhsComponents objectAtIndex:i] stringByTrimmingCharactersInSet:whitespace];
                        if ([lhsString isEqualToString:rhsItem])
                        {
                            return YES;
                        }
                    }
                }
                return NO;
        }
    }
    else if (opType == OP_NUMBER)
    {
        lhsValue = [[self performSelector:selector] doubleValue];
        
        if (comparator == COMPARISON_ONEOF)
        {
            rhsComponents = [expandedRHS componentsSeparatedByString:@","];
            count = [rhsComponents count];
            
            for (i = 0; i < count; i++)
            {
                rhsItem = [rhsComponents objectAtIndex:i];
                rhsValue = [rhsItem doubleValue];
                
                if (lhsValue == rhsValue)
                {
                    return YES;
                }
            }
            
            return NO;
        }
        else
        {
            rhsValue = [expandedRHS doubleValue];
            
            switch (comparator)
            {
                case COMPARISON_EQUAL:
                    return lhsValue == rhsValue;
                    
                case COMPARISON_NOTEQUAL:
                    return lhsValue != rhsValue;
                    
                case COMPARISON_LESSTHAN:
                    return lhsValue < rhsValue;
                    
                case COMPARISON_GREATERTHAN:
                    return lhsValue > rhsValue;
                    
                case COMPARISON_UNDEFINED:
                case COMPARISON_ONEOF:
                    // "Can't happen" - undefined should have been caught by the sanitizer, oneof is handled above.
                    OOLog(@"script.error.unexpectedOperator", @"***** SCRIPT ERROR: in %@, operator %@ is not valid for numbers, evaluating to false.", CurrentScriptDesc(), OOComparisonTypeToString(comparator));
                    return NO;
            }
        }
    }
    else if (opType == OP_BOOL)
    {
        lhsFlag = [[self performSelector:selector] isEqualToString:@"YES"];
        rhsFlag = [expandedRHS isEqualToString:@"YES"];
        
        switch (comparator)
        {
            case COMPARISON_EQUAL:
                return lhsFlag == rhsFlag;
                
            case COMPARISON_NOTEQUAL:
                return lhsFlag != rhsFlag;
                
            case COMPARISON_LESSTHAN:
            case COMPARISON_GREATERTHAN:
            case COMPARISON_UNDEFINED:
            case COMPARISON_ONEOF:
                // "Can't happen" - should have been caught by the sanitizer.
                OOLog(@"script.error.unexpectedOperator", @"***** SCRIPT ERROR: in %@, operator %@ is not valid for booleans, evaluating to false.", CurrentScriptDesc(), OOComparisonTypeToString(comparator));
                return NO;
        }
    }
    
    // What are we doing here?
    OOLog(@"script.error.fallthrough", @"***** SCRIPT ERROR: in %@, unhandled condition '%@' (%@). %@", CurrentScriptDesc(), [scriptCondition objectAtIndex:1], scriptCondition, @"This is an internal error, please report it.");
    return NO;
}

---

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

• src/Core/Entities/PlayerEntityLegacyScriptEngine.m