#include <PlayerEntityLegacyScriptEngine.h>

Instance Methods
(void)	- checkScript

(void)	- setScriptTarget:

(ShipEntity *)	- scriptTarget

(void)	- runScriptActions:withContextName:forTarget:

(void)	- runUnsanitizedScriptActions:allowingAIMethods:withContextName:forTarget:

(BOOL)	- scriptTestConditions:

(NSDictionary *)	- missionVariables

(NSString *)	- missionVariableForKey:

(void)	- setMissionVariable:forKey:

(NSMutableDictionary *)	- localVariablesForMission:

(NSString *)	- localVariableForKey:andMission:

(void)	- setLocalVariable:forKey:andMission:

(NSString *)	- mission_string

(NSString *)	- status_string

(NSString *)	- gui_screen_string

(NSNumber *)	- galaxy_number

(NSNumber *)	- planet_number

(NSNumber *)	- score_number

(NSNumber *)	- credits_number

(NSNumber *)	- scriptTimer_number

(NSNumber *)	- shipsFound_number

(NSNumber *)	- d100_number

(NSNumber *)	- pseudoFixedD100_number

(NSNumber *)	- d256_number

(NSNumber *)	- pseudoFixedD256_number

(NSNumber *)	- clock_number

(NSNumber *)	- clock_secs_number

(NSNumber *)	- clock_mins_number

(NSNumber *)	- clock_hours_number

(NSNumber *)	- clock_days_number

(NSNumber *)	- fuelLevel_number

(NSString *)	- dockedAtMainStation_bool

(NSString *)	- foundEquipment_bool

(NSString *)	- sunWillGoNova_bool

(NSString *)	- sunGoneNova_bool

(NSString *)	- missionChoice_string

(NSString *)	- missionKeyPress_string

(NSNumber *)	- dockedTechLevel_number

(NSString *)	- dockedStationName_string

(NSNumber *)	- systemGovernment_number

(NSString *)	- systemGovernment_string

(NSNumber *)	- systemEconomy_number

(NSString *)	- systemEconomy_string

(NSNumber *)	- systemTechLevel_number

(NSNumber *)	- systemPopulation_number

(NSNumber *)	- systemProductivity_number

(NSString *)	- commanderName_string

(NSString *)	- commanderRank_string

(NSString *)	- commanderShip_string

(NSString *)	- commanderShipDisplayName_string

(NSString *)	- commanderLegalStatus_string

(NSNumber *)	- commanderLegalStatus_number

(NSArray *)	- missionsList

(void)	- setMissionDescription:

(void)	- clearMissionDescription

(void)	- setMissionInstructions:forMission:

(void)	- setMissionInstructionsList:forMission:

(void)	- setMissionDescription:forMission:

(void)	- clearMissionDescriptionForMission:

(void)	- commsMessage:

(void)	- commsMessageByUnpiloted:

(void)	- consoleMessage3s:

(void)	- consoleMessage6s:

(void)	- setLegalStatus:

(void)	- awardCredits:

(void)	- awardShipKills:

(void)	- awardEquipment:

(void)	- removeEquipment:

(void)	- setPlanetinfo:

(void)	- setSpecificPlanetInfo:

(void)	- awardCargo:

(void)	- removeAllCargo

(void)	- removeAllCargo:

(void)	- useSpecialCargo:

(void)	- testForEquipment:

(void)	- awardFuel:

(void)	- messageShipAIs:

(void)	- ejectItem:

(void)	- addShips:

(void)	- addSystemShips:

(void)	- addShipsAt:

(void)	- addShipsAtPrecisely:

(void)	- addShipsWithinRadius:

(void)	- spawnShip:

(void)	- set:

(void)	- reset:

(void)	- increment:

(void)	- decrement:

(void)	- add:

(void)	- subtract:

(void)	- checkForShips:

(void)	- resetScriptTimer

(void)	- addMissionText:

(void)	- addLiteralMissionText:

(void)	- setMissionChoiceByTextEntry:

(void)	- setMissionChoices:

(void)	- setMissionChoicesDictionary:

(void)	- resetMissionChoice

(void)	- clearMissionScreen

(void)	- addMissionDestination:

(void)	- removeMissionDestination:

(void)	- showShipModel:

(void)	- setMissionMusic:

(NSString *)	- missionTitle

(void)	- setMissionTitle:

(void)	- setFuelLeak:

(NSNumber *)	- fuelLeakRate_number

(void)	- setSunNovaIn:

(void)	- launchFromStation

(void)	- blowUpStation

(void)	- sendAllShipsAway

(OOPlanetEntity *)	- addPlanet:

(OOPlanetEntity *)	- addMoon:

(void)	- debugOn

(void)	- debugOff

(void)	- debugMessage:

(NSString *)	- replaceVariablesInString:

(void)	- playSound:

(BOOL)	- addEqScriptForKey:

(void)	- removeEqScriptForKey:

(NSUInteger)	- eqScriptIndexForKey:

(void)	- targetNearestHostile

(void)	- targetNearestIncomingMissile

(void)	- setGalacticHyperspaceBehaviourTo:

(void)	- setGalacticHyperspaceFixedCoordsTo:

(void)	- clearMissionScreenID

(void)	- setMissionScreenID:

(NSString *)	- missionScreenID

(void)	- setGuiToMissionScreen

(void)	- refreshMissionScreenTextEntry

(void)	- setGuiToMissionScreenWithCallback:

(void)	- doMissionCallback

(void)	- endMissionScreenAndNoteOpportunity

(void)	- setBackgroundFromDescriptionsKey:

(void)	- addScene:atOffset:

(BOOL)	- processSceneDictionary:atOffset:

(BOOL)	- processSceneString:atOffset:

(OOINLINE NSString *)	- CurrentScriptDesc(void) `[implementation]`

(OOINLINE OOEntityStatus)	- RecursiveRemapStatus `[implementation]`

(NSDictionary *)	- worldScriptsRequiringTickle `[implementation]`

(BOOL)	- scriptTestCondition: `[implementation]`

(NSString *)	- expandScriptRightHandSide: `[implementation]`

(NSString *)	- expandMessage: `[implementation]`

(void)	- setMissionImage: `[implementation]`

(void)	- setMissionBackground: `[implementation]`

Class Methods
(static NSString *)	+ CurrentScriptNameOr `[implementation]`

(static void)	+ PerformScriptActions `[implementation]`

(static void)	+ PerformConditionalStatment `[implementation]`

(static void)	+ PerformActionStatment `[implementation]`

(static BOOL)	+ TestScriptConditions `[implementation]`

Detailed Description

Definition at line 57 of file PlayerEntityLegacyScriptEngine.h.

Method Documentation

◆ add:

- (void) add: (NSString *) missionVariableString_value

Extends class PlayerEntity.

Definition at line 1807 of file PlayerEntityLegacyScriptEngine.m.

            :(NSString *)missionVariableString_value
{
    NSString*   missionVariableString = nil;
    NSString*   valueString;
    double  value;
    NSMutableArray* tokens = ScanTokensFromString(missionVariableString_value);
    BOOL hasMissionPrefix, hasLocalPrefix;
 
    if ([tokens count] < 2)
    {
        OOLog(kOOLogSyntaxAdd, @"***** SCRIPT ERROR: in %@, CANNOT ADD: '%@'", CurrentScriptDesc(), missionVariableString_value);
        return;
    }
 
    missionVariableString = [tokens objectAtIndex:0];
    [tokens removeObjectAtIndex:0];
    valueString = [tokens componentsJoinedByString:@" "];
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
 
    if (hasMissionPrefix)
    {
        value = [[self missionVariableForKey:missionVariableString] doubleValue];
        value += [valueString doubleValue];
        [self setMissionVariable:[NSString stringWithFormat:@"%f", value] forKey:missionVariableString];
    }
    else if (hasLocalPrefix)
    {
        value = [[self localVariableForKey:missionVariableString andMission:sCurrentMissionKey] doubleValue];
        value += [valueString doubleValue];
        [self setLocalVariable:[NSString stringWithFormat:@"%f", value] forKey:missionVariableString andMission:sCurrentMissionKey];
    }
    else
    {
        OOLog(kOOLogSyntaxAdd, @"***** SCRIPT ERROR: in %@, CANNOT ADD: '%@' -- IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString_value, missionVariableString_value);
    }
}

References count, kOOLogSyntaxAdd, PlayerEntity::localVariableForKey:andMission:, PlayerEntity::missionVariableForKey:, nil, OOLog, ScanTokensFromString(), PlayerEntity::setLocalVariable:forKey:andMission:, and PlayerEntity::setMissionVariable:forKey:.

Here is the call graph for this function:

◆ addEqScriptForKey:

- (BOOL) addEqScriptForKey: (NSString *) eq_key

Extends class PlayerEntity.

Definition at line 2853 of file PlayerEntityLegacyScriptEngine.m.

                          :(NSString *)eq_key
{
    if (eq_key == nil) return NO;
    
    NSString            *scriptName = [[OOEquipmentType equipmentTypeWithIdentifier:eq_key] scriptName];
    
    OOLog(@"player.equipmentScript", @"Added equipment %@, with the following script property: '%@'.", eq_key, scriptName);
 
    if (scriptName == nil) return NO;
    
    NSMutableDictionary *properties = [NSMutableDictionary dictionary];
    
    // no duplicates!
    NSArray *eqScript = nil;
    foreach (eqScript, eqScripts)
    {
        NSString *key = [eqScript oo_stringAtIndex:0];
        if ([key isEqualToString: eq_key])  return NO;
    }
    
    [properties setObject:self forKey:@"ship"];
    [properties setObject:eq_key forKey:@"equipmentKey"];
    OOScript *s = [OOScript jsScriptFromFileNamed:scriptName properties:properties];
    if (s == nil) return NO;
    
    OOLog(@"player.equipmentScript", @"Script '%@': installation %@successful.", scriptName,(s == nil ? @"un" : @""));
    
    [eqScripts addObject:[NSArray arrayWithObjects:eq_key,s,nil]];
    if (primedEquipment == [eqScripts count] - 1) primedEquipment++;   // if primed-none, keep it as primed-none.
    OOLog(@"player.equipmentScript", @"Scriptable equipment available: %lu.", [eqScripts count]);
    return YES;
}

References count, OOEquipmentType::equipmentTypeWithIdentifier:, OOScript::jsScriptFromFileNamed:properties:, nil, OOLog, and OOEquipmentType::scriptName.

Here is the call graph for this function:

◆ addLiteralMissionText:

- (void) addLiteralMissionText: (NSString *) text

Extends class PlayerEntity.

Definition at line 1919 of file PlayerEntityLegacyScriptEngine.m.

                              :(NSString *)text
{
    if (text != nil)
    {
        GuiDisplayGen *gui = [UNIVERSE gui];
        
        NSString *para = nil;
        foreach (para, [text componentsSeparatedByString:@"\n"])
        {
            missionTextRow = [gui addLongText:para startingAtRow:missionTextRow align:GUI_ALIGN_LEFT];
        }
    }
}

References GuiDisplayGen::addLongText:startingAtRow:align:, and nil.

Here is the call graph for this function:

◆ addMissionDestination:

- (void) addMissionDestination: (NSString *) destinations

Extends class PlayerEntity.

Definition at line 2117 of file PlayerEntityLegacyScriptEngine.m.

                              :(NSString *)destinations
{
    unsigned j;
    int dest;
    NSMutableArray *tokens = ScanTokensFromString(destinations);
    
    for (j = 0; j < [tokens count]; j++)
    {
        dest = [tokens oo_intAtIndex:j];
        if (dest < 0 || dest > 255)
            continue;
 
        [self addMissionDestinationMarker:[self defaultMarker:dest]];
    }
}

References PlayerEntity::addMissionDestinationMarker:, PlayerEntity::defaultMarker:, and ScanTokensFromString().

Here is the call graph for this function:

◆ addMissionText:

- (void) addMissionText: (NSString *) textKey

Extends class PlayerEntity.

Definition at line 1901 of file PlayerEntityLegacyScriptEngine.m.

                       : (NSString *)textKey
{
    NSString            *text = nil;
    
    if ([textKey isEqualToString:lastTextKey])  return; // don't repeatedly add the same text
    [lastTextKey release];
    lastTextKey = [textKey copy];
    
    // Replace literal \n in strings with line breaks and perform expansions.
    text = [[UNIVERSE missiontext] oo_stringForKey:textKey];
    if (text == nil)  return;
    text = OOExpandWithOptions(OOStringExpanderDefaultRandomSeed(), kOOExpandBackslashN, text);
    text = [self replaceVariablesInString:text];
    
    [self addLiteralMissionText:text];
}

References PlayerEntity::addLiteralMissionText:, kOOExpandBackslashN, nil, OOExpandWithOptions, OOStringExpanderDefaultRandomSeed(), and PlayerEntity::replaceVariablesInString:.

Here is the call graph for this function:

◆ addMoon:

- (OOPlanetEntity *) addMoon: (NSString *) moonKey

Extends class PlayerEntity.

Definition at line 2361 of file PlayerEntityLegacyScriptEngine.m.

                            : (NSString *)moonKey
{
    OOLog(kOOLogNoteAddPlanet, @"DEBUG: addMoon '%@'", moonKey);
 
    if (!UNIVERSE)
        return nil;
    NSDictionary* dict = [[UNIVERSE systemManager] getPropertiesForSystemKey:moonKey];
    if (!dict)
    {
        OOLog(@"script.error.addPlanet.keyNotFound", @"***** ERROR: could not find an entry in planetinfo.plist for '%@'", moonKey);
        return nil;
    }
 
    OOLog(kOOLogDebugAddPlanet, @"DEBUG: initMoonFromDictionary: %@", dict);
    OOPlanetEntity *planet = [[[OOPlanetEntity alloc] initFromDictionary:dict withAtmosphere:NO andSeed:[[UNIVERSE systemManager] getRandomSeedForCurrentSystem] forSystem:system_id] autorelease];
    
    Quaternion planetOrientation;
    if (ScanQuaternionFromString([dict objectForKey:@"orientation"], &planetOrientation))
    {
        [planet setOrientation:planetOrientation];
    }
 
    if (![dict objectForKey:@"position"])
    {
        OOLog(@"script.error.addPlanet.noPosition", @"***** ERROR: you must specify a position for scripted moon '%@' before it can be created", moonKey);
        return nil;
    }
    
    NSString *positionString = [dict objectForKey:@"position"];
    if([positionString hasPrefix:@"abs "] && ([UNIVERSE planet] != nil || [UNIVERSE sun] !=nil))
    {
        OOLogWARN(@"script.deprecated", @"setting %@ for %@ '%@' in 'abs' inside .plists can cause compatibility issues across Oolite versions. Use coordinates relative to main system objects instead.",@"position",@"moon",moonKey);
    }
    HPVector posn = [UNIVERSE coordinatesFromCoordinateSystemString:positionString];
    if (posn.x || posn.y || posn.z)
    {
        OOLog(kOOLogDebugAddPlanet, @"moon position (%.2f %.2f %.2f) derived from %@", posn.x, posn.y, posn.z, positionString);
    }
    else
    {
        ScanHPVectorFromString(positionString, &posn);
        OOLog(kOOLogDebugAddPlanet, @"moon position (%.2f %.2f %.2f) derived from %@", posn.x, posn.y, posn.z, positionString);
    }
    [planet setPosition: posn];
    
    [UNIVERSE addEntity:planet];
    return planet;
}

References kOOLogDebugAddPlanet, kOOLogNoteAddPlanet, nil, OOLog, OOLogWARN, ScanHPVectorFromString(), ScanQuaternionFromString(), and UNIVERSE.

Here is the call graph for this function:

◆ addPlanet:

- (OOPlanetEntity *) addPlanet: (NSString *) planetKey

Extends class PlayerEntity.

Definition at line 2309 of file PlayerEntityLegacyScriptEngine.m.

                              : (NSString *)planetKey
{
    OOLog(kOOLogNoteAddPlanet, @"addPlanet: %@", planetKey);
 
    if (!UNIVERSE)
        return nil;
    NSDictionary* dict = [[UNIVERSE systemManager] getPropertiesForSystemKey:planetKey];
    if (!dict)
    {
        OOLog(@"script.error.addPlanet.keyNotFound", @"***** ERROR: could not find an entry in planetinfo.plist for '%@'", planetKey);
        return nil;
    }
 
    /*- add planet -*/
    OOLog(kOOLogDebugAddPlanet, @"DEBUG: initPlanetFromDictionary: %@", dict);
    OOPlanetEntity *planet = [[[OOPlanetEntity alloc] initFromDictionary:dict withAtmosphere:YES andSeed:[[UNIVERSE systemManager] getRandomSeedForCurrentSystem] forSystem:system_id] autorelease];
    
    Quaternion planetOrientation;
    if (ScanQuaternionFromString([dict objectForKey:@"orientation"], &planetOrientation))
    {
        [planet setOrientation:planetOrientation];
    }
 
    if (![dict objectForKey:@"position"])
    {
        OOLog(@"script.error.addPlanet.noPosition", @"***** ERROR: you must specify a position for scripted planet '%@' before it can be created", planetKey);
        return nil;
    }
    
    NSString *positionString = [dict objectForKey:@"position"];
    if([positionString hasPrefix:@"abs "] && ([UNIVERSE planet] != nil || [UNIVERSE sun] !=nil))
    {
        OOLogWARN(@"script.deprecated", @"setting %@ for %@ '%@' in 'abs' inside .plists can cause compatibility issues across Oolite versions. Use coordinates relative to main system objects instead.",@"position",@"planet",planetKey);
    }
    
    HPVector posn = [UNIVERSE coordinatesFromCoordinateSystemString:positionString];
    if (posn.x || posn.y || posn.z)
    {
        OOLog(kOOLogDebugAddPlanet, @"planet position (%.2f %.2f %.2f) derived from %@", posn.x, posn.y, posn.z, positionString);
    }
    else
    {
        ScanHPVectorFromString(positionString, &posn);
        OOLog(kOOLogDebugAddPlanet, @"planet position (%.2f %.2f %.2f) derived from %@", posn.x, posn.y, posn.z, positionString);
    }
    [planet setPosition: posn];
    
    [UNIVERSE addEntity:planet];
    return planet;
}

References kOOLogDebugAddPlanet, kOOLogNoteAddPlanet, nil, OOLog, OOLogWARN, ScanHPVectorFromString(), ScanQuaternionFromString(), and UNIVERSE.

Here is the call graph for this function:

◆ addScene:atOffset:

- (void) addScene:		(NSArray *)	items
atOffset:		(Vector)	off

Extends class PlayerEntity.

Definition at line 2585 of file PlayerEntityLegacyScriptEngine.m.

                 :(NSArray *)items atOffset:(Vector)off
{
    unsigned                i;
    
    if (items == nil)  return;
    
    for (i = 0; i < [items count]; i++)
    {
        id item = [items objectAtIndex:i];
        if ([item isKindOfClass:[NSString class]])
        {
            [self processSceneString:item atOffset: off];
        }
        else if ([item isKindOfClass:[NSArray class]])
        {
            [self addScene:item atOffset: off];
        }
        else if ([item isKindOfClass:[NSDictionary class]])
        {
            [self processSceneDictionary:item atOffset: off];
        }
    }
}

References PlayerEntity::addScene:atOffset:, nil, PlayerEntity::processSceneDictionary:atOffset:, and PlayerEntity::processSceneString:atOffset:.

Here is the call graph for this function:

◆ addShips:

- (void) addShips: (NSString *) roles_number

Extends class PlayerEntity.

Definition at line 1499 of file PlayerEntityLegacyScriptEngine.m.

                 :(NSString *)roles_number
{
    NSMutableArray* tokens = ScanTokensFromString(roles_number);
    NSString*   roleString = nil;
    NSString*   numberString = nil;
    
    if ([tokens count] != 2)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, CANNOT addShips: '%@' (expected <role> <count>)", CurrentScriptDesc(), roles_number);
        return;
    }
    
    roleString = [tokens objectAtIndex:0];
    numberString = [tokens objectAtIndex:1];
    
    int number = [numberString intValue];
    if (number < 0)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, can't add %i ships -- that's less than zero, y'know..", CurrentScriptDesc(), number);
        return;
    }
    
    OOLog(kOOLogNoteAddShips, @"DEBUG: Going to add %d ships with role '%@'", number, roleString);
    
    while (number--)
        [UNIVERSE witchspaceShipWithPrimaryRole:roleString];
}

References count, kOOLogNoteAddShips, kOOLogSyntaxAddShips, nil, OOLog, and ScanTokensFromString().

Here is the call graph for this function:

◆ addShipsAt:

- (void) addShipsAt: (NSString *) roles_number_system_x_y_z

Extends class PlayerEntity.

Definition at line 1560 of file PlayerEntityLegacyScriptEngine.m.

                   :(NSString *)roles_number_system_x_y_z
{
    NSMutableArray* tokens = ScanTokensFromString(roles_number_system_x_y_z);
 
    NSString*   roleString = nil;
    NSString*   numberString = nil;
    NSString*   systemString = nil;
    NSString*   xString = nil;
    NSString*   yString = nil;
    NSString*   zString = nil;
 
    if ([tokens count] != 6)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, CANNOT addShipsAt: '%@' (expected <role> <count> <coordinate-system> <x> <y> <z>)", CurrentScriptDesc(), roles_number_system_x_y_z);
        return;
    }
 
    roleString = [tokens objectAtIndex:0];
    numberString = [tokens objectAtIndex:1];
    systemString = [tokens objectAtIndex:2];
    xString = [tokens objectAtIndex:3];
    yString = [tokens objectAtIndex:4];
    zString = [tokens objectAtIndex:5];
 
    HPVector posn = make_HPvector([xString doubleValue], [yString doubleValue], [zString doubleValue]);
 
    int number = [numberString intValue];
    if (number < 1)
    {
        OOLog(kOOLogSyntaxAddShips, @"----- WARNING in %@  Tried to add %i ships -- no ship added.", CurrentScriptDesc(), number);
        return;
    }
 
    OOLog(kOOLogNoteAddShips, @"DEBUG: Going to add %d ship(s) with role '%@' at point (%.3f, %.3f, %.3f) using system %@", number, roleString, posn.x, posn.y, posn.z, systemString);
 
    if (![UNIVERSE addShips: number withRole:roleString nearPosition: posn withCoordinateSystem: systemString])
    {
        OOLog(kOOLogScriptAddShipsFailed, @"***** SCRIPT ERROR: in %@, %@ could not add %u ships with role \"%@\"", CurrentScriptDesc(), @"addShipsAt:", number, roleString);
    }
}

References count, kOOLogNoteAddShips, kOOLogScriptAddShipsFailed, kOOLogSyntaxAddShips, nil, OOLog, ScanTokensFromString(), and UNIVERSE.

Here is the call graph for this function:

◆ addShipsAtPrecisely:

- (void) addShipsAtPrecisely: (NSString *) roles_number_system_x_y_z

Extends class PlayerEntity.

Definition at line 1602 of file PlayerEntityLegacyScriptEngine.m.

                            :(NSString *)roles_number_system_x_y_z
{
    NSMutableArray* tokens = ScanTokensFromString(roles_number_system_x_y_z);
 
    NSString*   roleString = nil;
    NSString*   numberString = nil;
    NSString*   systemString = nil;
    NSString*   xString = nil;
    NSString*   yString = nil;
    NSString*   zString = nil;
 
    if ([tokens count] != 6)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@,* CANNOT addShipsAtPrecisely: '%@' (expected <role> <count> <coordinate-system> <x> <y> <z>)", CurrentScriptDesc(), roles_number_system_x_y_z);
        return;
    }
 
    roleString = [tokens objectAtIndex:0];
    numberString = [tokens objectAtIndex:1];
    systemString = [tokens objectAtIndex:2];
    xString = [tokens objectAtIndex:3];
    yString = [tokens objectAtIndex:4];
    zString = [tokens objectAtIndex:5];
 
    HPVector posn = make_HPvector([xString doubleValue], [yString doubleValue], [zString doubleValue]);
 
    int number = [numberString intValue];
    if (number < 1)
    {
        OOLog(kOOLogSyntaxAddShips, @"----- WARNING: in %@, Can't add %i ships -- no ship added.", CurrentScriptDesc(), number);
        return;
    }
 
    OOLog(kOOLogNoteAddShips, @"DEBUG: Going to add %d ship(s) with role '%@' precisely at point (%.3f, %.3f, %.3f) using system %@", number, roleString, posn.x, posn.y, posn.z, systemString);
 
    if (![UNIVERSE addShips: number withRole:roleString atPosition: posn withCoordinateSystem: systemString])
    {
        OOLog(kOOLogScriptAddShipsFailed, @"***** SCRIPT ERROR: in %@, %@ could not add %u ships with role '%@'", CurrentScriptDesc(), @"addShipsAtPrecisely:", number, roleString);
    }
}

References count, kOOLogNoteAddShips, kOOLogScriptAddShipsFailed, kOOLogSyntaxAddShips, nil, OOLog, ScanTokensFromString(), and UNIVERSE.

Here is the call graph for this function:

◆ addShipsWithinRadius:

- (void) addShipsWithinRadius: (NSString *) roles_number_system_x_y_z_r

Extends class PlayerEntity.

Definition at line 1644 of file PlayerEntityLegacyScriptEngine.m.

                             :(NSString *)roles_number_system_x_y_z_r
{
    NSMutableArray* tokens = ScanTokensFromString(roles_number_system_x_y_z_r);
 
    if ([tokens count] != 7)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, CANNOT 'addShipsWithinRadius: %@' (expected <role> <count> <coordinate-system> <x> <y> <z> <radius>))", CurrentScriptDesc(), roles_number_system_x_y_z_r);
        return;
    }
 
    NSString* roleString = [tokens objectAtIndex:0];
    int number = [[tokens objectAtIndex:1] intValue];
    NSString* systemString = [tokens objectAtIndex:2];
    double x = [[tokens objectAtIndex:3] doubleValue];
    double y = [[tokens objectAtIndex:4] doubleValue];
    double z = [[tokens objectAtIndex:5] doubleValue];
    GLfloat r = [[tokens objectAtIndex:6] floatValue];
    HPVector posn = make_HPvector(x, y, z);
 
    if (number < 1)
    {
        OOLog(kOOLogSyntaxAddShips, @"----- WARNING: in %@, can't add %i ships -- no ship added.", CurrentScriptDesc(), number);
        return;
    }
 
    OOLog(kOOLogNoteAddShips, @"DEBUG: Going to add %d ship(s) with role '%@' within %.2f radius about point (%.3f, %.3f, %.3f) using system %@", number, roleString, r, x, y, z, systemString);
 
    if (![UNIVERSE addShips:number withRole: roleString nearPosition: posn withCoordinateSystem: systemString withinRadius: r])
    {
        OOLog(kOOLogScriptAddShipsFailed, @"***** SCRIPT ERROR :in %@, %@ could not add %u ships with role \"%@\"", CurrentScriptDesc(), @"addShipsWithinRadius:", number, roleString);
    }
}

References count, kOOLogNoteAddShips, kOOLogScriptAddShipsFailed, kOOLogSyntaxAddShips, OOLog, ScanTokensFromString(), UNIVERSE, x, and y.

Here is the call graph for this function:

◆ addSystemShips:

- (void) addSystemShips: (NSString *) roles_number_position

Extends class PlayerEntity.

Definition at line 1528 of file PlayerEntityLegacyScriptEngine.m.

                       :(NSString *)roles_number_position
{
    NSMutableArray* tokens = ScanTokensFromString(roles_number_position);
    NSString*   roleString = nil;
    NSString*   numberString = nil;
    NSString*   positionString = nil;
 
    if ([tokens count] != 3)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, CANNOT addSystemShips: '%@' (expected <role> <count> <position>)", CurrentScriptDesc(), roles_number_position);
        return;
    }
 
    roleString = [tokens objectAtIndex:0];
    numberString = [tokens objectAtIndex:1];
    positionString = [tokens objectAtIndex:2];
 
    int number = [numberString intValue];
    double posn = [positionString doubleValue];
    if (number < 0)
    {
        OOLog(kOOLogSyntaxAddShips, @"***** SCRIPT ERROR: in %@, can't add %i ships -- that's less than zero, y'know..", CurrentScriptDesc(), number);
        return;
    }
 
    OOLog(kOOLogNoteAddShips, @"DEBUG: Going to add %d ships with role '%@' at a point %.3f along route1", number, roleString, posn);
 
    while (number--)
        [UNIVERSE addShipWithRole:roleString nearRouteOneAt:posn];
}

References count, kOOLogNoteAddShips, kOOLogSyntaxAddShips, nil, OOLog, and ScanTokensFromString().

Here is the call graph for this function:

◆ awardCargo:

- (void) awardCargo: (NSString *) amount_typeString

Extends class PlayerEntity.

Definition at line 1346 of file PlayerEntityLegacyScriptEngine.m.

                   :(NSString *)amount_typeString
{
    if (scriptTarget != self)  return;
 
    NSArray                 *tokens = ScanTokensFromString(amount_typeString);
    OOCargoQuantityDelta    amount;
    OOCommodityType          type;
    OOMassUnit                unit;
 
    if ([tokens count] != 2)
    {
        OOLog(kOOLogSyntaxAwardCargo, @"***** SCRIPT ERROR: in %@, CANNOT awardCargo: '%@' (%@)", CurrentScriptDesc(), amount_typeString, @"bad parameter count");
        return;
    }
    
 
    type = [tokens oo_stringAtIndex:1];
    if (![[UNIVERSE commodities] goodDefined:type])
    {
        OOLog(kOOLogSyntaxAwardCargo, @"***** SCRIPT ERROR: in %@, CANNOT awardCargo: '%@' (%@)", CurrentScriptDesc(), amount_typeString, @"unknown type");
        return;
    }
    
    amount = [tokens oo_intAtIndex:0];
    if (amount < 0)
    {
        OOLog(kOOLogSyntaxAwardCargo, @"***** SCRIPT ERROR: in %@, CANNOT awardCargo: '%@' (%@)", CurrentScriptDesc(), amount_typeString, @"negative quantity");
        return;
    }
    
    unit = [shipCommodityData massUnitForGood:type];
    if (specialCargo && unit == UNITS_TONS)
    {
        OOLog(kOOLogSyntaxAwardCargo, @"***** SCRIPT ERROR: in %@, CANNOT awardCargo: '%@' (%@)", CurrentScriptDesc(), amount_typeString, @"cargo hold full with special cargo");
        return;
    }
    
    [self awardCommodityType:type amount:amount];
}

References PlayerEntity::awardCommodityType:amount:, count, kOOLogSyntaxAwardCargo, OOLog, ScanTokensFromString(), scriptTarget, UNITS_TONS, and UNIVERSE.

Here is the call graph for this function:

◆ awardCredits:

- (void) awardCredits: (NSString *) valueString

Extends class PlayerEntity.

Definition at line 1223 of file PlayerEntityLegacyScriptEngine.m.

                     :(NSString *)valueString
{
    if (scriptTarget != self)  return;
    
    /*  We can't use -longLongValue here for Mac OS X 10.4 compatibility, but
        we don't need to since larger values have never been supported for
        legacy scripts.
    */
    int64_t award = [valueString intValue];
    award *= 10;
    if (award < 0 && credits < (OOCreditsQuantity)-award)  credits = 0;
    else  credits += award;
}

References scriptTarget.

Here is the call graph for this function:

◆ awardEquipment:

- (void) awardEquipment: (NSString *) equipString

Extends class PlayerEntity.

Definition at line 1247 of file PlayerEntityLegacyScriptEngine.m.

                       :(NSString *)equipString  //eg. EQ_NAVAL_ENERGY_UNIT
{
    if (scriptTarget != self)  return;
    
    if ([equipString isEqualToString:@"EQ_FUEL"])
    {
        [self setFuel:[self fuelCapacity]];
    }
    
    OOEquipmentType *eqType = [OOEquipmentType equipmentTypeWithIdentifier:equipString];
    
    if ([eqType isMissileOrMine])
    {
        [self mountMissileWithRole:equipString];
    }
    else if([equipString hasPrefix:@"EQ_WEAPON"] && ![equipString hasSuffix:@"_DAMAGED"])
    {
        OOLog(kOOLogSyntaxAwardEquipment, @"***** SCRIPT ERROR: in %@, CANNOT award undamaged weapon:'%@'. Damaged weapons can be awarded instead.", CurrentScriptDesc(), equipString);
    }
    else if ([equipString hasSuffix:@"_DAMAGED"] && [self hasEquipmentItem:[equipString substringToIndex:[equipString length] - [@"_DAMAGED" length]]])
    {
        OOLog(kOOLogSyntaxAwardEquipment, @"***** SCRIPT ERROR: in %@, CANNOT award damaged equipment:'%@'. Undamaged version already equipped.", CurrentScriptDesc(), equipString);
    }
    else if ([eqType canCarryMultiple] || ![self hasEquipmentItem:equipString])
    {
        [self addEquipmentItem:equipString withValidation:YES inContext:@"scripted"];
    }
}

References PlayerEntity::addEquipmentItem:withValidation:inContext:, OOEquipmentType::equipmentTypeWithIdentifier:, ShipEntity::fuelCapacity, kOOLogSyntaxAwardEquipment, PlayerEntity::mountMissileWithRole:, OOLog, scriptTarget, and ShipEntity::setFuel:.

Here is the call graph for this function:

◆ awardFuel:

- (void) awardFuel: (NSString *) valueString

Extends class PlayerEntity.

Definition at line 1451 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *)valueString  // add to fuel up to 7.0 LY
{
    int delta  = 10 * [valueString floatValue];
    OOFuelQuantity scriptTargetFuelBeforeAward = [scriptTarget fuel];
 
    if (delta < 0 && scriptTargetFuelBeforeAward < (unsigned)-delta)  [scriptTarget setFuel:0];
    else
    {
        [scriptTarget setFuel:(scriptTargetFuelBeforeAward + delta)];
    }
}

References ShipEntity::fuel, and ShipEntity::setFuel:.

Here is the call graph for this function:

◆ awardShipKills:

- (void) awardShipKills: (NSString *) valueString

Extends class PlayerEntity.

Definition at line 1238 of file PlayerEntityLegacyScriptEngine.m.

                       :(NSString *)valueString
{
    if (scriptTarget != self)  return;
    
    int value = [valueString intValue];
    if (0 < value)  ship_kills += value;
}

References scriptTarget.

Here is the call graph for this function:

◆ blowUpStation

- (void) blowUpStation

Extends class PlayerEntity.

Definition at line 2256 of file PlayerEntityLegacyScriptEngine.m.

{
    StationEntity       *mainStation = nil;
    
    mainStation = [UNIVERSE station];
    if (mainStation != nil)
    {
        [UNIVERSE unMagicMainStation];
        [mainStation takeEnergyDamage:500000000.0 from:nil becauseOf:nil weaponIdentifier:@""];    // 500 million should do it!
    }
}

References blowUpStation, nil, and StationEntity::takeEnergyDamage:from:becauseOf:weaponIdentifier:.

Referenced by blowUpStation.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkForShips:

- (void) checkForShips: (NSString *) roleString

Extends class PlayerEntity.

Definition at line 1887 of file PlayerEntityLegacyScriptEngine.m.

                      :(NSString *)roleString
{
    shipsFound = [UNIVERSE countShipsWithPrimaryRole:roleString];
}

References shipsFound.

◆ checkScript

- (void) checkScript

Extends class PlayerEntity.

Definition at line 302 of file PlayerEntityLegacyScriptEngine.m.

{
    BOOL                        wasRunningScript = sRunningScript;
    OOEntityStatus                status, restoreStatus;
    
    NSDictionary *tickleScripts = [self worldScriptsRequiringTickle];
    if ([tickleScripts count] == 0)
    {
        // Quick exit if we only have JS scripts.
        return;
    }
    
    [self setScriptTarget:self];
    
    /*  World scripts can potentially be invoked recursively, through
        scriptActionOnTarget: and possibly other mechanisms. This is bad, but
        that's the way it is. Legacy world scripts rely on only seeing certain
        player statuses once per "event". To ensure this, we must lie about
        the player's status when invoked recursively.
        
        Of course, there are also methods in the game that rely on status not
        lying. However, I don't believe any that rely on these particular
        statuses can be legitimately invoked by scripts. The alternative would
        be to track the "status-as-seen-by-scripts" separately from the "real"
        status, which'd risk synchronization problems.
        
        In summary, scriptActionOnTarget: is bad, and calling it from scripts
        rather than AIs is very bad.
        -- Ahruman, 20080302
        
        Addendum: scriptActionOnTarget: is currently not in the whitelist for
        script methods. Let's hope this doesn't turn out to be a problem.
        -- Ahruman, 20090208
    */
    status = [self status];
    restoreStatus = status;
    @try
    {
        if (sRunningScript)
        {
            status = RecursiveRemapStatus(status);
            [self setStatus:status];
        }
        sRunningScript = YES;
        
        // After all that, actually running the scripts is trivial.
        [[tickleScripts allValues] makeObjectsPerformSelector:@selector(runWithTarget:) withObject:self];
    }
    @catch (NSException *exception)
    {
        OOLog(kOOLogException, @"***** Exception running world scripts: %@ : %@", [exception name], [exception reason]);
    }
    
    // Restore anti-recursion measures.
    sRunningScript = wasRunningScript;
    if (status != restoreStatus)  [self setStatus:restoreStatus];
}

References checkScript, count, kOOLogException, OOLog, RecursiveRemapStatus, PlayerEntity::setScriptTarget:, ShipEntity::setStatus:, sRunningScript, Entity::status, and PlayerEntity::worldScriptsRequiringTickle.

Referenced by checkScript.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearMissionDescription

- (void) clearMissionDescription

Extends class PlayerEntity.

Definition at line 887 of file PlayerEntityLegacyScriptEngine.m.

{
    [self clearMissionDescriptionForMission:sCurrentMissionKey];
}

References clearMissionDescription, and PlayerEntity::clearMissionDescriptionForMission:.

Referenced by clearMissionDescription.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearMissionDescriptionForMission:

- (void) clearMissionDescriptionForMission: (NSString *) key

Extends class PlayerEntity.

Definition at line 893 of file PlayerEntityLegacyScriptEngine.m.

                                          :(NSString *)key
{
    if (!key)
    {
        OOLogERR(kOOLogScriptMissionDescNoKey, @"in %@, mission key not set", CurrentScriptDesc());
        return;
    }
    
    if (![mission_variables objectForKey:key]) return;
    
    [mission_variables removeObjectForKey:key];
}

References kOOLogScriptMissionDescNoKey, and OOLogERR.

◆ clearMissionScreen

- (void) clearMissionScreen

Extends class PlayerEntity.

Definition at line 2106 of file PlayerEntityLegacyScriptEngine.m.

{
    [self setMissionOverlayDescriptor:nil];
    [self setMissionBackgroundDescriptor:nil];
    [self setMissionBackgroundSpecial:nil];
    [self setMissionTitle:nil];
    [self setMissionMusic:nil];
    [self showShipModel:nil];
}

References clearMissionScreen, PlayerEntity::setMissionBackgroundDescriptor:, PlayerEntity::setMissionBackgroundSpecial:, PlayerEntity::setMissionMusic:, PlayerEntity::setMissionOverlayDescriptor:, PlayerEntity::setMissionTitle:, and PlayerEntity::showShipModel:.

Referenced by clearMissionScreen.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearMissionScreenID

- (void) clearMissionScreenID

Extends class PlayerEntity.

Definition at line 2447 of file PlayerEntityLegacyScriptEngine.m.

{
    [_missionScreenID release];
    _missionScreenID = nil;
}

References clearMissionScreenID, and nil.

Referenced by clearMissionScreenID.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clock_days_number

- (NSNumber *) clock_days_number

Extends class PlayerEntity.

Definition at line 1030 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithUnsignedLongLong:ship_clock / 86400.0];
}

References clock_days_number.

Referenced by clock_days_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clock_hours_number

- (NSNumber *) clock_hours_number

Extends class PlayerEntity.

Definition at line 1024 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithUnsignedLongLong:ship_clock / 3600.0];
}

References clock_hours_number.

Referenced by clock_hours_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clock_mins_number

- (NSNumber *) clock_mins_number

Extends class PlayerEntity.

Definition at line 1018 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithUnsignedLongLong:ship_clock / 60.0];
}

References clock_mins_number.

Referenced by clock_mins_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clock_number

- (NSNumber *) clock_number

Extends class PlayerEntity.

Definition at line 1006 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithDouble:ship_clock];
}

References clock_number.

Referenced by clock_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clock_secs_number

- (NSNumber *) clock_secs_number

Extends class PlayerEntity.

Definition at line 1012 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithUnsignedLongLong:ship_clock];
}

References clock_secs_number.

Referenced by clock_secs_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commanderLegalStatus_number

- (NSNumber *) commanderLegalStatus_number

Extends class PlayerEntity.

Definition at line 962 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:[self legalStatus]];
}

References commanderLegalStatus_number, and PlayerEntity::legalStatus.

Referenced by commanderLegalStatus_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commanderLegalStatus_string

- (NSString *) commanderLegalStatus_string

Extends class PlayerEntity.

Definition at line 974 of file PlayerEntityLegacyScriptEngine.m.

{
    return OODisplayStringFromLegalStatus(legalStatus);
}

References commanderLegalStatus_string, and OODisplayStringFromLegalStatus().

Referenced by commanderLegalStatus_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commanderName_string

- (NSString *) commanderName_string

Extends class PlayerEntity.

Definition at line 1155 of file PlayerEntityLegacyScriptEngine.m.

{
    return [self commanderName];
}

References PlayerEntity::commanderName, and commanderName_string.

Referenced by commanderName_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commanderRank_string

- (NSString *) commanderRank_string

Extends class PlayerEntity.

Definition at line 1161 of file PlayerEntityLegacyScriptEngine.m.

{
    return OODisplayRatingStringFromKillCount([self score]);
}

References commanderRank_string, and OODisplayRatingStringFromKillCount().

Referenced by commanderRank_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commanderShip_string

- (NSString *) commanderShip_string

Extends class PlayerEntity.

Definition at line 1167 of file PlayerEntityLegacyScriptEngine.m.

{
    return [self name];
}

References commanderShip_string, and ShipEntity::name.

Referenced by commanderShip_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commanderShipDisplayName_string

- (NSString *) commanderShipDisplayName_string

Extends class PlayerEntity.

Definition at line 1173 of file PlayerEntityLegacyScriptEngine.m.

{
    return [self displayName];
}

References commanderShipDisplayName_string, and ShipEntity::displayName.

Referenced by commanderShipDisplayName_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commsMessage:

- (void) commsMessage: (NSString *) valueString

Extends class PlayerEntity.

Definition at line 1196 of file PlayerEntityLegacyScriptEngine.m.

                     :(NSString *)valueString
{   
    [UNIVERSE addCommsMessage:[self expandMessage:valueString] forCount:4.5];
}

References PlayerEntity::expandMessage:.

Here is the call graph for this function:

◆ commsMessageByUnpiloted:

- (void) commsMessageByUnpiloted: (NSString *) valueString

Extends class PlayerEntity.

Definition at line 1205 of file PlayerEntityLegacyScriptEngine.m.

                                :(NSString *)valueString
{
    [self commsMessage:valueString];
}

References PlayerEntity::commsMessage:.

Here is the call graph for this function:

◆ consoleMessage3s:

- (void) consoleMessage3s: (NSString *) valueString

Extends class PlayerEntity.

Definition at line 1211 of file PlayerEntityLegacyScriptEngine.m.

                         :(NSString *)valueString
{
    [UNIVERSE addMessage:[self expandMessage:valueString] forCount: 3];
}

References PlayerEntity::expandMessage:.

Here is the call graph for this function:

◆ consoleMessage6s:

- (void) consoleMessage6s: (NSString *) valueString

Extends class PlayerEntity.

Definition at line 1217 of file PlayerEntityLegacyScriptEngine.m.

                         :(NSString *)valueString
{
    [UNIVERSE addMessage:[self expandMessage:valueString] forCount: 6];
}

References PlayerEntity::expandMessage:.

Here is the call graph for this function:

◆ credits_number

- (NSNumber *) credits_number

Extends class PlayerEntity.

Definition at line 943 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithDouble:[self creditBalance]];
}

References PlayerEntity::creditBalance, and credits_number.

Referenced by credits_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CurrentScriptDesc(void)

- (OOINLINE NSString * CurrentScriptDesc(void)) (void)

implementation

Extends class PlayerEntity.

Definition at line 129 of file PlayerEntityLegacyScriptEngine.m.

{
    return CurrentScriptNameOr(@"<anonymous actions>");
}

References CurrentScriptNameOr, and OOINLINE.

Here is the call graph for this function:

◆ CurrentScriptNameOr

+ (static NSString *) CurrentScriptNameOr (NSString *) alternative

implementation

Extends class PlayerEntity.

Definition at line 119 of file PlayerEntityLegacyScriptEngine.m.

{
    if (sCurrentMissionKey != nil && ![sCurrentMissionKey hasPrefix:kActionTempPrefix])
    {
        return [NSString stringWithFormat:@"\"%@\"", sCurrentMissionKey];
    }
    return alternative;
}

References kActionTempPrefix, nil, and sCurrentMissionKey.

Referenced by CurrentScriptDesc(void).

Here is the caller graph for this function:

◆ d100_number

- (NSNumber *) d100_number

Extends class PlayerEntity.

Definition at line 980 of file PlayerEntityLegacyScriptEngine.m.

{
    int d100 = ranrot_rand() % 100;
    return [NSNumber numberWithInt:d100];
}

References d100_number, and ranrot_rand.

Referenced by d100_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ d256_number

- (NSNumber *) d256_number

Extends class PlayerEntity.

Definition at line 993 of file PlayerEntityLegacyScriptEngine.m.

{
    int d256 = ranrot_rand() % 256;
    return [NSNumber numberWithInt:d256];
}

References d256_number, and ranrot_rand.

Referenced by d256_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ debugMessage:

- (void) debugMessage: (NSString *) args

Extends class PlayerEntity.

Definition at line 2425 of file PlayerEntityLegacyScriptEngine.m.

                     :(NSString *)args
{
    OOLog(kOOLogDebugMessage, @"SCRIPT debugMessage: %@", args);
}

References kOOLogDebugMessage, and OOLog.

◆ debugOff

- (void) debugOff

Extends class PlayerEntity.

Definition at line 2418 of file PlayerEntityLegacyScriptEngine.m.

{
    OOLog(kOOLogDebugOnOff, @"%@", @"SCRIPT debug messages OFF");
    OOLogSetDisplayMessagesInClass(kOOLogDebugOnMetaClass, NO);
}

References debugOff, kOOLogDebugOnMetaClass, kOOLogDebugOnOff, OOLog, and OOLogSetDisplayMessagesInClass().

Referenced by debugOff.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ debugOn

- (void) debugOn

Extends class PlayerEntity.

Definition at line 2411 of file PlayerEntityLegacyScriptEngine.m.

{
    OOLogSetDisplayMessagesInClass(kOOLogDebugOnMetaClass, YES);
    OOLog(kOOLogDebugOnOff, @"%@", @"SCRIPT debug messages ON");
}

References debugOn, kOOLogDebugOnMetaClass, kOOLogDebugOnOff, OOLog, and OOLogSetDisplayMessagesInClass().

Referenced by debugOn.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ decrement:

- (void) decrement: (NSString *) missionVariableString

Extends class PlayerEntity.

Definition at line 1780 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *)missionVariableString
{
    BOOL hasMissionPrefix, hasLocalPrefix;
    int value = 0;
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
    
    if (hasMissionPrefix)
    {
        value = [[self missionVariableForKey:missionVariableString] intValue];
        value--;
        [self setMissionVariable:[NSString stringWithFormat:@"%d", value] forKey:missionVariableString];
    }
    else if (hasLocalPrefix)
    {
        value = [[self localVariableForKey:missionVariableString andMission:sCurrentMissionKey] intValue];
        value--;
        [self setLocalVariable:[NSString stringWithFormat:@"%d", value] forKey:missionVariableString andMission:sCurrentMissionKey];
    }
    else
    {
        OOLog(kOOLogSyntaxDecrement, @"***** SCRIPT ERROR: in %@, IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString);
    }
}

References kOOLogSyntaxDecrement, PlayerEntity::localVariableForKey:andMission:, PlayerEntity::missionVariableForKey:, OOLog, PlayerEntity::setLocalVariable:forKey:andMission:, and PlayerEntity::setMissionVariable:forKey:.

Here is the call graph for this function:

◆ dockedAtMainStation_bool

- (NSString *) dockedAtMainStation_bool

Extends class PlayerEntity.

Definition at line 1042 of file PlayerEntityLegacyScriptEngine.m.

{
    if ([self dockedAtMainStation])  return @"YES";
    else  return @"NO";
}

References dockedAtMainStation_bool.

Referenced by dockedAtMainStation_bool.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dockedStationName_string

- (NSString *) dockedStationName_string

Extends class PlayerEntity.

Definition at line 1089 of file PlayerEntityLegacyScriptEngine.m.

{
    NSString            *result = nil;
    if ([self status] != STATUS_DOCKED)  return @"NONE";
    
    result = [self dockedStationName];
    if (result == nil)  result = @"UNKNOWN";
    return result;
}

References PlayerEntity::dockedStationName, dockedStationName_string, and nil.

Referenced by dockedStationName_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dockedTechLevel_number

- (NSNumber *) dockedTechLevel_number

Extends class PlayerEntity.

Definition at line 1079 of file PlayerEntityLegacyScriptEngine.m.

{
    StationEntity *dockedStation = [self dockedStation];
    if (!dockedStation) 
    {
        return [self systemTechLevel_number];
    }
    return [NSNumber numberWithUnsignedInteger:[dockedStation equivalentTechLevel]];
}

References PlayerEntity::dockedStation, dockedTechLevel_number, StationEntity::equivalentTechLevel, and PlayerEntity::systemTechLevel_number.

Referenced by dockedTechLevel_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doMissionCallback

- (void) doMissionCallback

Extends class PlayerEntity.

Definition at line 2439 of file PlayerEntityLegacyScriptEngine.m.

{
    // make sure we don't call the same callback twice
    _missionWithCallback = NO;
    [[OOJavaScriptEngine sharedEngine] runMissionCallback];
}

References doMissionCallback, OOJavaScriptEngine::runMissionCallback, and OOJavaScriptEngine::sharedEngine.

Referenced by doMissionCallback.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ejectItem:

- (void) ejectItem: (NSString *) item_key

Extends class PlayerEntity.

Definition at line 1492 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *)itemKey
{
    if (scriptTarget == nil)  scriptTarget = self;
    [scriptTarget ejectShipOfType:itemKey];
}

References ShipEntity::ejectShipOfType:, nil, and scriptTarget.

Here is the call graph for this function:

◆ endMissionScreenAndNoteOpportunity

- (void) endMissionScreenAndNoteOpportunity

Extends class PlayerEntity.

Definition at line 2466 of file PlayerEntityLegacyScriptEngine.m.

{
    _missionAllowInterrupt = NO;
    [self clearMissionScreenID];
    // Older scripts might intercept missionScreenEnded first, and call secondary mission screens.
    if(![self doWorldEventUntilMissionScreen:OOJSID("missionScreenEnded")])
    {
        // if we're here, no mission screen is running. Opportunity! :)
        [self doWorldEventUntilMissionScreen:OOJSID("missionScreenOpportunity")];
    }
}

References PlayerEntity::clearMissionScreenID, PlayerEntity::doWorldEventUntilMissionScreen:, endMissionScreenAndNoteOpportunity, and OOJSID.

Referenced by endMissionScreenAndNoteOpportunity.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ eqScriptIndexForKey:

- (NSUInteger) eqScriptIndexForKey: (NSString *) eq_key

Extends class PlayerEntity.

Definition at line 2911 of file PlayerEntityLegacyScriptEngine.m.

                                  :(NSString *)eq_key
{
    NSUInteger          i, count = [eqScripts count];
    
    if (eq_key != nil)
    {
        for (i = 0; i < count; i++)
        {
            NSString *key = [[eqScripts oo_arrayAtIndex:i] oo_stringAtIndex:0];
            if ([key isEqualToString: eq_key]) return i;
        }
    }
    
    return count;
}

References count, and nil.

◆ expandMessage:

- (NSString *) expandMessage: (NSString *) valueString

implementation

Extends class PlayerEntity.

Definition at line 1181 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

implementation

Extends class PlayerEntity.

Definition at line 610 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:@" "];
}

◆ foundEquipment_bool

- (NSString *) foundEquipment_bool

Extends class PlayerEntity.

Definition at line 1049 of file PlayerEntityLegacyScriptEngine.m.

{
    return (found_equipment)? @"YES" : @"NO";
}

References foundEquipment_bool.

Referenced by foundEquipment_bool.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fuelLeakRate_number

- (NSNumber *) fuelLeakRate_number

Extends class PlayerEntity.

Definition at line 2234 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithFloat:[self fuelLeakRate]];
}

References PlayerEntity::fuelLeakRate, and fuelLeakRate_number.

Referenced by fuelLeakRate_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fuelLevel_number

- (NSNumber *) fuelLevel_number

Extends class PlayerEntity.

Definition at line 1036 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithFloat:floor(0.1 * fuel)];
}

References fuelLevel_number.

Referenced by fuelLevel_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ galaxy_number

- (NSNumber *) galaxy_number

Extends class PlayerEntity.

Definition at line 925 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:[self currentGalaxyID]];
}

References PlayerEntity::currentGalaxyID, and galaxy_number.

Referenced by PlayerEntity::doBookkeeping:, PlayerEntity::enterGalacticWitchspace, galaxy_number, PlayerEntity::galaxyNumber, PlayerEntity::setCommanderDataFromDictionary:, PlayerEntity::setSystemID:, PlayerEntity::setTargetSystemID:, and PlayerEntity::setUpAndConfirmOK:saveGame:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gui_screen_string

- (NSString *) gui_screen_string

Extends class PlayerEntity.

Definition at line 919 of file PlayerEntityLegacyScriptEngine.m.

{
    return OOStringFromGUIScreenID(gui_screen);
}

References gui_screen_string, and OOStringFromGUIScreenID().

Referenced by gui_screen_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ increment:

- (void) increment: (NSString *) missionVariableString

Extends class PlayerEntity.

Definition at line 1753 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *)missionVariableString
{
    BOOL hasMissionPrefix, hasLocalPrefix;
    int value = 0;
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
 
    if (hasMissionPrefix)
    {
        value = [[self missionVariableForKey:missionVariableString] intValue];
        value++;
        [self setMissionVariable:[NSString stringWithFormat:@"%d", value] forKey:missionVariableString];
    }
    else if (hasLocalPrefix)
    {
        value = [[self localVariableForKey:missionVariableString andMission:sCurrentMissionKey] intValue];
        value++;
        [self setLocalVariable:[NSString stringWithFormat:@"%d", value] forKey:missionVariableString andMission:sCurrentMissionKey];
    }
    else
    {
        OOLog(kOOLogSyntaxIncrement, @"***** SCRIPT ERROR: in %@, IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString);
    }
}

References kOOLogSyntaxIncrement, PlayerEntity::localVariableForKey:andMission:, PlayerEntity::missionVariableForKey:, OOLog, PlayerEntity::setLocalVariable:forKey:andMission:, and PlayerEntity::setMissionVariable:forKey:.

Here is the call graph for this function:

◆ launchFromStation

- (void) launchFromStation

Extends class PlayerEntity.

Definition at line 2247 of file PlayerEntityLegacyScriptEngine.m.

{
    // ensure autosave is ready for the next unscripted launch
    if ([UNIVERSE autoSave]) [UNIVERSE setAutoSaveNow:YES];
    if ([self status] == STATUS_DOCKING)  [self setStatus:STATUS_DOCKED]; // needed here to prevent the normal update from continuing with docking.
    [self leaveDock:[self dockedStation]];
}

References PlayerEntity::dockedStation, launchFromStation, PlayerEntity::leaveDock:, ShipEntity::setStatus:, and UNIVERSE.

Referenced by launchFromStation.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ localVariableForKey:andMission:

- (NSString *) localVariableForKey:		(NSString *)	variableName
andMission:		(NSString *)	missionKey

Extends class PlayerEntity.

Definition at line 686 of file PlayerEntityLegacyScriptEngine.m.

                                 :(NSString *)variableName andMission:(NSString *)missionKey
{
    return [[localVariables oo_dictionaryForKey:missionKey] objectForKey:variableName];
}

◆ localVariablesForMission:

- (NSMutableDictionary *) localVariablesForMission: (NSString *) missionKey

Extends class PlayerEntity.

Definition at line 669 of file PlayerEntityLegacyScriptEngine.m.

                                                 :(NSString *)missionKey
{
    NSMutableDictionary     *result = nil;
    
    if (missionKey == nil)  return nil;
    
    result = [localVariables objectForKey:missionKey];
    if (result == nil)
    {
        result = [NSMutableDictionary dictionary];
        [localVariables setObject:result forKey:missionKey];
    }
    
    return result;
}

References nil.

◆ messageShipAIs:

- (void) messageShipAIs: (NSString *) roles_message

Extends class PlayerEntity.

Definition at line 1464 of file PlayerEntityLegacyScriptEngine.m.

                       :(NSString *)roles_message
{
    NSMutableArray* tokens = ScanTokensFromString(roles_message);
    NSString*   roleString = nil;
    NSString*   messageString = nil;
 
    if ([tokens count] < 2)
    {
        OOLog(kOOLogSyntaxMessageShipAIs, @"***** SCRIPT ERROR: in %@, CANNOT messageShipAIs: '%@' (bad parameter count)", CurrentScriptDesc(), roles_message);
        return;
    }
 
    roleString = [tokens objectAtIndex:0];
    [tokens removeObjectAtIndex:0];
    messageString = [tokens componentsJoinedByString:@" "];
 
    NSArray *targets = [UNIVERSE findShipsMatchingPredicate:HasPrimaryRolePredicate
                                                  parameter:roleString
                                                    inRange:-1
                                                   ofEntity:nil];
 
    ShipEntity *target;
    foreach(target, targets) {
        [[target getAI] reactToMessage:messageString context:@"messageShipAIs:"];
    }
}

References count, ShipEntity::getAI, kOOLogSyntaxMessageShipAIs, nil, OOLog, AI::reactToMessage:context:, and ScanTokensFromString().

Here is the call graph for this function:

◆ mission_string

- (NSString *) mission_string

Extends class PlayerEntity.

Definition at line 907 of file PlayerEntityLegacyScriptEngine.m.

{
    return sMissionStringValue;
}

References mission_string, and sMissionStringValue.

Referenced by mission_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ missionChoice_string

- (NSString *) missionChoice_string

Extends class PlayerEntity.

Definition at line 1067 of file PlayerEntityLegacyScriptEngine.m.

{
    return missionChoice;
}

References missionChoice_string.

Referenced by missionChoice_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ missionKeyPress_string

- (NSString *) missionKeyPress_string

Extends class PlayerEntity.

Definition at line 1073 of file PlayerEntityLegacyScriptEngine.m.

{
    return missionKeyPress;
}

References missionKeyPress_string.

Referenced by missionKeyPress_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ missionScreenID

- (NSString *) missionScreenID

Extends class PlayerEntity.

Definition at line 2460 of file PlayerEntityLegacyScriptEngine.m.

{
    return _missionScreenID;
}

References missionScreenID.

Referenced by missionScreenID.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ missionsList

- (NSArray *) missionsList

Extends class PlayerEntity.

Definition at line 711 of file PlayerEntityLegacyScriptEngine.m.

{
    NSEnumerator            *scriptEnum = nil;
    NSString                *scriptName = nil;
    NSString                *vars = nil;
    NSMutableArray          *result1 = nil;
    NSMutableArray          *result2 = nil;
    
    result1 = [NSMutableArray array];
    result2 = [NSMutableArray array];
 
    NSArray*    passengerManifest = [self passengerList];
    NSArray*    contractManifest = [self contractList];
    NSArray*    parcelManifest = [self parcelList]; 
 
    if ([passengerManifest count] > 0)
    {
        [result2 addObject:[[NSArray arrayWithObject:DESC(@"manifest-passengers")] arrayByAddingObjectsFromArray:passengerManifest]];
    }
 
    if ([parcelManifest count] > 0)
    {
        [result2 addObject:[[NSArray arrayWithObject:DESC(@"manifest-parcels")] arrayByAddingObjectsFromArray:parcelManifest]];
    }
 
    if ([contractManifest count] > 0)
    {
        [result2 addObject:[[NSArray arrayWithObject:DESC(@"manifest-contracts")] arrayByAddingObjectsFromArray:contractManifest]];
    }
 
    /* For proper display, array entries need to all be after string
     * entries, so sort them now */ 
    for (scriptEnum = [worldScripts keyEnumerator]; (scriptName = [scriptEnum nextObject]); )
    {
        vars = [mission_variables objectForKey:scriptName];
        
        if (vars != nil)
        {
            if ([vars isKindOfClass:[NSString class]])
            {
                [result1 addObject:vars];
            }
            else if ([vars isKindOfClass:[NSArray class]])
            {
                BOOL found = NO;
                NSArray *element = nil;
                foreach (element, result2)
                {
                    if ([[element oo_stringAtIndex:0] isEqualToString:[(NSArray*)vars oo_stringAtIndex:0]])
                    {
 
                        [result2 removeObject:element];
                        NSRange notTheHeader;
                        notTheHeader.location = 1;
                        notTheHeader.length = [(NSArray*)vars count]-1;
                        [result2 addObject:[element arrayByAddingObjectsFromArray:[(NSArray*)vars subarrayWithRange:notTheHeader]]];
                        found = YES;
                        break;
                    }
                }
                if (!found)
                {
                    [result2 addObject:vars];
                }
            }
        }
    }
    return [result1 arrayByAddingObjectsFromArray:result2];
}

References PlayerEntity::contractList, count, missionsList, nil, PlayerEntity::parcelList, and PlayerEntity::passengerList.

Referenced by missionsList.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ missionTitle

- (NSString *) missionTitle

Extends class PlayerEntity.

Definition at line 2173 of file PlayerEntityLegacyScriptEngine.m.

{
    return _missionTitle;
}

References missionTitle.

Referenced by missionTitle.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ missionVariableForKey:

- (NSString *) missionVariableForKey: (NSString *) key

Extends class PlayerEntity.

Definition at line 651 of file PlayerEntityLegacyScriptEngine.m.

                                   :(NSString *)key
{
    NSString *result = nil;
    if (key != nil)  result = [mission_variables objectForKey:key];
    return result;
}

References nil.

◆ missionVariables

- (NSDictionary *) missionVariables

Extends class PlayerEntity.

Definition at line 645 of file PlayerEntityLegacyScriptEngine.m.

{
    return mission_variables;
}

References missionVariables.

Referenced by missionVariables.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PerformActionStatment

+ (static void) PerformActionStatment		(NSArray *)	statement
		(Entity *)	target

implementation

Extends class PlayerEntity.

Definition at line 185 of file PlayerEntityLegacyScriptEngine.m.

{
    /*  A sanitized action statement takes the form of an array:
        (false, selector [, argument])
        The first element is always false. The second is the method selector
        (as a string). If the method takes an argument, the third argument is
        the argument string.
 
        The sanitizer is responsible for ensuring that there is an argument,
        even if it's the empty string, for any selector with a colon at the
        end, and no arguments for selectors without colons. The runner can
        therefore use the list's element count as a flag without examining the
        selector.
    */
    
    NSString                *selectorString = nil;
    NSString                *argumentString = nil;
    NSString                *expandedString = nil;
    SEL                     selector = NULL;
    NSMutableDictionary     *locals = nil;
    PlayerEntity            *player = PLAYER;
    
    selectorString = [statement objectAtIndex:1];
    if ([statement count] > 2)  argumentString = [statement objectAtIndex:2];
    
    selector = NSSelectorFromString(selectorString);
    
    if (target == nil || ![target respondsToSelector:selector])
    {
        target = player;
    }
    
    if (argumentString != nil)
    {
        // Method with argument; substitute [description] expressions.
        locals = [player localVariablesForMission:sCurrentMissionKey];
        expandedString = OOExpandDescriptionString(OOStringExpanderDefaultRandomSeed(), argumentString, nil, locals, nil, kOOExpandNoOptions);
        
        [target performSelector:selector withObject:expandedString];
    }
    else
    {
        // Method without argument.
        [target performSelector:selector];
    }
}

References count, kOOExpandNoOptions, PlayerEntity::localVariablesForMission:, nil, OOExpandDescriptionString(), OOStringExpanderDefaultRandomSeed(), PerformActionStatment, and PLAYER.

Referenced by PerformActionStatment, and PerformScriptActions.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PerformConditionalStatment

+ (static void) PerformConditionalStatment		(NSArray *)	actions
		(Entity *)	target

implementation

Extends class PlayerEntity.

Definition at line 158 of file PlayerEntityLegacyScriptEngine.m.

{
    /*  A sanitized conditional statement takes the form of an array:
        (true, conditions, trueActions, falseActions)
        The first element is always true. The second is an array of conditions.
        The third and four elements are actions to perform if the conditions
        evaluate to true or false, respectively.
    */
    
    NSArray             *conditions = nil;
    NSArray             *actions = nil;
    
    conditions = [statement objectAtIndex:1];
    
    if (TestScriptConditions(conditions))
    {
        actions = [statement objectAtIndex:2];
    }
    else
    {
        actions = [statement objectAtIndex:3];
    }
    
    PerformScriptActions(actions, target);
}

References nil, PerformConditionalStatment, PerformScriptActions, and TestScriptConditions.

Referenced by PerformConditionalStatment, and PerformScriptActions.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PerformScriptActions

+ (static void) PerformScriptActions		(NSArray *)	actions
		(Entity *)	target

implementation

Extends class PlayerEntity.

Definition at line 141 of file PlayerEntityLegacyScriptEngine.m.

{
    NSArray *statement = nil;
    foreach (statement, actions)
    {
        if ([[statement objectAtIndex:0] boolValue])
        {
            PerformConditionalStatment(statement, target);
        }
        else
        {
            PerformActionStatment(statement, target);
        }
    }
}

References nil, PerformActionStatment, PerformConditionalStatment, and PerformScriptActions.

Referenced by PerformConditionalStatment, PerformScriptActions, and runScriptActions:withContextName:forTarget:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ planet_number

- (NSNumber *) planet_number

Extends class PlayerEntity.

Definition at line 931 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:[self currentSystemID]];
}

References PlayerEntity::currentSystemID, and planet_number.

Referenced by planet_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ playSound:

- (void) playSound: (NSString *) soundName

Extends class PlayerEntity.

Definition at line 2431 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *) soundName
{
    [self playLegacyScriptSound:soundName];
}

References PlayerEntity::playLegacyScriptSound:.

Here is the call graph for this function:

◆ processSceneDictionary:atOffset:

- (BOOL) processSceneDictionary:		(NSDictionary *)	couplet
atOffset:		(Vector)	off

Extends class PlayerEntity.

Definition at line 2610 of file PlayerEntityLegacyScriptEngine.m.

                               :(NSDictionary *) couplet atOffset:(Vector) off
{
    NSArray *conditions = [couplet objectForKey:@"conditions"];
    NSArray *actions = nil;
    if ([couplet objectForKey:@"do"])
        actions = [NSArray arrayWithObject: [couplet objectForKey:@"do"]];
    NSArray *else_actions = nil;
    if ([couplet objectForKey:@"else"])
        else_actions = [NSArray arrayWithObject: [couplet objectForKey:@"else"]];
    BOOL success = YES;
    if (conditions == nil)
    {
        OOLog(@"script.scene.couplet.badConditions", @"***** SCENE ERROR: %@ - conditions not %@, returning %@.", [couplet description], @" found",@"YES and performing 'do' actions");
    }
    else
    {
        if (![conditions isKindOfClass:[NSArray class]])
        {
            OOLog(@"script.scene.couplet.badConditions", @"***** SCENE ERROR: %@ - conditions not %@, returning %@.", [conditions description], @"an array",@"NO");
            return NO;
        }
    }
 
    // check conditions..
    success = TestScriptConditions(OOSanitizeLegacyScriptConditions(conditions, @"<scene dictionary conditions>"));
 
    // perform successful actions...
    if ((success) && (actions) && [actions count])
        [self addScene: actions atOffset: off];
 
    // perform unsuccessful actions
    if ((!success) && (else_actions) && [else_actions count])
        [self addScene: else_actions atOffset: off];
 
    return success;
}

References PlayerEntity::addScene:atOffset:, count, nil, OOLog, OOSanitizeLegacyScriptConditions(), and TestScriptConditions.

Here is the call graph for this function:

◆ processSceneString:atOffset:

- (BOOL) processSceneString:		(NSString*)	item
atOffset:		(Vector)	off

Extends class PlayerEntity.

Definition at line 2648 of file PlayerEntityLegacyScriptEngine.m.

                           :(NSString*) item atOffset:(Vector) off
{
    Vector  model_p0;
    Quaternion  model_q;
    
    if (!item)
        return NO;
    NSArray * i_info = ScanTokensFromString(item);
    if (!i_info)
        return NO;
    NSString* i_key = [(NSString*)[i_info objectAtIndex:0] lowercaseString];
 
    OOLog(kOOLogNoteProcessSceneString, @"..... processing %@ (%@)", i_info, i_key);
 
    //
    // recursively add further scenes:
    //
    if ([i_key isEqualToString:@"scene"])
    {
        if ([i_info count] != 5)   // must be scene_key_x_y_z
            return NO;              //         0.... 1.. 2 3 4
        NSString* scene_key = (NSString*)[i_info objectAtIndex: 1];
        Vector  scene_offset = {0};
        ScanVectorFromString([[i_info subarrayWithRange:NSMakeRange(2, 3)] componentsJoinedByString:@" "], &scene_offset);
        scene_offset.x += off.x;   scene_offset.y += off.y;   scene_offset.z += off.z;
        NSArray * scene_items = (NSArray *)[[UNIVERSE descriptions] objectForKey:scene_key];
        OOLog(kOOLogDebugProcessSceneStringAddScene, @"::::: adding scene: '%@'", scene_key);
        //
        if (scene_items)
        {
            [self addScene: scene_items atOffset: scene_offset];
            return YES;
        }
        else
            return NO;
    }
    //
    // Add ship models:
    //
    if ([i_key isEqualToString:@"ship"]||[i_key isEqualToString:@"model"]||[i_key isEqualToString:@"role"])
    {
        if ([i_info count] != 10)  // must be item_name_x_y_z_W_X_Y_Z_align
        {
            return NO;              //         0... 1... 2 3 4 5 6 7 8 9....
        }
        
        ShipEntity* ship = nil;
        
        if ([i_key isEqualToString:@"ship"]||[i_key isEqualToString:@"model"])
        {
            ship = [UNIVERSE newShipWithName:[i_info oo_stringAtIndex: 1]];
        }
        else if ([i_key isEqualToString:@"role"])
        {
            ship = [UNIVERSE newShipWithRole:[i_info oo_stringAtIndex: 1]];
        }
        if (!ship)
            return NO;
 
        ScanVectorAndQuaternionFromString([[i_info subarrayWithRange:NSMakeRange(2, 7)] componentsJoinedByString:@" "], &model_p0, &model_q);
        
        Vector  model_offset = positionOffsetForShipInRotationToAlignment(ship, model_q, [i_info oo_stringAtIndex:9]);
        model_p0 = vector_add(model_p0, vector_subtract(off, model_offset));
 
        OOLog(kOOLogDebugProcessSceneStringAddModel, @"::::: adding model to scene:'%@'", ship);
        [ship setOrientation: model_q];
        [ship setPosition: vectorToHPVector(model_p0)];
        [UNIVERSE setMainLightPosition:(Vector){ DEMO_LIGHT_POSITION }]; // set light origin
        [ship setScanClass: CLASS_NO_DRAW];
        [ship switchAITo: @"nullAI.plist"];
        [UNIVERSE addEntity: ship]; // STATUS_IN_FLIGHT, AI state GLOBAL
        [ship setStatus: STATUS_COCKPIT_DISPLAY];
        [ship setRoll: 0.0];
        [ship setPitch: 0.0];
        [ship setVelocity: kZeroVector];
        [ship setBehaviour: BEHAVIOUR_STOP_STILL];
 
        [ship release];
        return YES;
    }
    //
    // Add player ship model:
    //
    if ([i_key isEqualToString:@"player"])
    {
        if ([i_info count] != 9)   // must be player_x_y_z_W_X_Y_Z_align
            return NO;              //         0..... 1 2 3 4 5 6 7 8....
 
        ShipEntity* doppelganger = [UNIVERSE newShipWithName:[self shipDataKey]];   // retain count = 1
        if (!doppelganger)
            return NO;
        
        ScanVectorAndQuaternionFromString([[i_info subarrayWithRange:NSMakeRange( 1, 7)] componentsJoinedByString:@" "], &model_p0, &model_q);
        
        Vector  model_offset = positionOffsetForShipInRotationToAlignment( doppelganger, model_q, (NSString*)[i_info objectAtIndex:8]);
        model_p0.x += off.x - model_offset.x;
        model_p0.y += off.y - model_offset.y;
        model_p0.z += off.z - model_offset.z;
 
        OOLog(kOOLogDebugProcessSceneStringAddModel, @"::::: adding model to scene:'%@'", doppelganger);
        [doppelganger setOrientation: model_q];
        [doppelganger setPosition: vectorToHPVector(model_p0)];
        [UNIVERSE setMainLightPosition:(Vector){ DEMO_LIGHT_POSITION }]; // set light origin
        [doppelganger setScanClass: CLASS_NO_DRAW];
        [doppelganger switchAITo: @"nullAI.plist"];
        [UNIVERSE addEntity: doppelganger];
        [doppelganger setStatus: STATUS_COCKPIT_DISPLAY];
        [doppelganger setRoll: 0.0];
        [doppelganger setPitch: 0.0];
        [doppelganger setVelocity: kZeroVector];
        [doppelganger setBehaviour: BEHAVIOUR_STOP_STILL];
 
        [doppelganger release];
        return YES;
    }
    //
    // Add  planet model: selected via gui-scene-show-planet/-local-planet
    //
    if ([i_key isEqualToString:@"local-planet"] || [i_key isEqualToString:@"target-planet"])
    {
        if ([i_info count] != 4)   // must be xxxxx-planet_x_y_z
            return NO;              //         0........... 1 2 3
        
        // sunlight position for F7 screen is chosen pseudo randomly from  4 different positions.
        if (info_system_id & 8)
        {
            _sysInfoLight = (info_system_id & 2) ? (Vector){ -10000.0, 4000.0, -10000.0 } : (Vector){ -12000.0, -5000.0, -10000.0 };
        }
        else
        {
            _sysInfoLight = (info_system_id & 2) ? (Vector){ 6000.0, -5000.0, -10000.0 } : (Vector){ 6000.0, 4000.0, -10000.0 };
        }
 
        [UNIVERSE setMainLightPosition:_sysInfoLight]; // set light origin
        
#if NEW_PLANETS
        OOPlanetEntity *originalPlanet = nil;
        if ([i_key isEqualToString:@"local-planet"] && [UNIVERSE sun])
        {
            originalPlanet = [UNIVERSE planet];
        }
        else
        {
            originalPlanet = [[[OOPlanetEntity alloc] initAsMainPlanetForSystem:info_system_id] autorelease];
        }
        OOPlanetEntity *doppelganger = [originalPlanet miniatureVersion];
        if (doppelganger == nil)  return NO;
 
#else
        OOPlanetEntity* doppelganger = nil;
        NSMutableDictionary *planetInfo = [NSMutableDictionary dictionaryWithDictionary:[UNIVERSE generateSystemData:target_system_seed]];
        
        if ([i_key isEqualToString:@"local-planet"] && [UNIVERSE sun])
        {
            OOPlanetEntity *mainPlanet = [UNIVERSE planet];
            OOTexture *texture = [mainPlanet texture];
            if (texture != nil)
            {
                [planetInfo setObject:texture forKey:@"_oo_textureObject"];
                [planetInfo oo_setBool:[mainPlanet isExplicitlyTextured] forKey:@"_oo_isExplicitlyTextured"];
                [planetInfo oo_setBool:YES forKey:@"mainForLocalSystem"];
                //[planetInfo oo_setQuaternion:[mainPlanet orientation] forKey:@"orientation"]; // the orientation is overwritten later on, without regard for the real planet's orientation.
            }
        }
        
        doppelganger = [[OOPlanetEntity alloc] initFromDictionary:planetInfo withAtmosphere:YES andSeed:target_system_seed];
        [doppelganger miniaturize];
        [doppelganger autorelease];
        
        if (doppelganger == nil)  return NO;
#endif
        
        ScanVectorFromString([[i_info subarrayWithRange:NSMakeRange(1, 3)] componentsJoinedByString:@" "], &model_p0);
        
        // miniature radii are roughly between 60 and 120. Place miniatures with a radius bigger than 60 a bit futher away.
        model_p0 = vector_multiply_scalar(model_p0, 1 - 0.5 * ((60 - [doppelganger radius]) / 60));
        
        model_p0 = vector_add(model_p0, off);
        
        // TODO: find better quaternion values.     
#if NEW_PLANETS
        //Quaternion model_q = { 0.83, 0.365148, 0.182574, 0.0 }; // shows new planets' north pole.
        //Quaternion model_q = { 0.83, -0.365148, 0.182574, 0.0 }; // shows new planets' south pole.
        Quaternion model_q = { 0.83, 0.12, 0.44, 0.0 }; // new planets - default orientation.
#else
        //model_q = make_quaternion( M_SQRT1_2, 0.314, M_SQRT1_2, 0.0 );
        Quaternion model_q = { 0.833492, 0.333396, 0.440611, 0.0 }; 
#endif
        OOLog(kOOLogDebugProcessSceneStringAddMiniPlanet, @"::::: adding %@ to scene:'%@'", i_key, doppelganger);
        [doppelganger setOrientation: model_q];
        // HPVect: mission screen coordinates are small enough that we don't need high-precision for calculations
        [doppelganger setPosition: vectorToHPVector(model_p0)];
        /* MKW - add rotation based on current time 
         *     - necessary to duplicate the rotation already performed in PlanetEntity.m since we reset the orientation above. */
        int     deltaT = floor(fmod([self clockTimeAdjusted], 86400));
        [doppelganger update: deltaT];
        [UNIVERSE addEntity:doppelganger];
        
        return YES;
    }
    
    return NO;
}

References PlayerEntity::addScene:atOffset:, count, kOOLogDebugProcessSceneStringAddMiniPlanet, kOOLogDebugProcessSceneStringAddModel, kOOLogDebugProcessSceneStringAddScene, kOOLogNoteProcessSceneString, nil, OOLog, ScanTokensFromString(), ScanVectorAndQuaternionFromString(), ScanVectorFromString(), ShipEntity::setBehaviour:, Entity::setOrientation:, ShipEntity::setPitch:, Entity::setPosition:, ShipEntity::setRoll:, Entity::setScanClass:, ShipEntity::setStatus:, Entity::setVelocity:, ShipEntity::shipDataKey, ShipEntity::switchAITo:, and UNIVERSE.

Here is the call graph for this function:

◆ pseudoFixedD100_number

- (NSNumber *) pseudoFixedD100_number

Extends class PlayerEntity.

Definition at line 987 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:[self systemPseudoRandom100]];
}

References pseudoFixedD100_number, and PlayerEntity::systemPseudoRandom100.

Referenced by pseudoFixedD100_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pseudoFixedD256_number

- (NSNumber *) pseudoFixedD256_number

Extends class PlayerEntity.

Definition at line 1000 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:[self systemPseudoRandom256]];
}

References pseudoFixedD256_number, and PlayerEntity::systemPseudoRandom256.

Referenced by pseudoFixedD256_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RecursiveRemapStatus

- (OOINLINE OOEntityStatus) RecursiveRemapStatus (OOEntityStatus) status

implementation

Extends class PlayerEntity.

Definition at line 260 of file PlayerEntityLegacyScriptEngine.m.

{
    // Some player stutuses should only be seen once per "event".
    // This remaps them to something innocuous in case of recursion.
    if (status == STATUS_DOCKING ||
        status == STATUS_LAUNCHING ||
        status == STATUS_ENTERING_WITCHSPACE ||
        status == STATUS_EXITING_WITCHSPACE)
    {
        return STATUS_IN_FLIGHT;
    }
    else
    {
        return status;
    }
}

References OOINLINE.

Referenced by checkScript.

Here is the caller graph for this function:

◆ refreshMissionScreenTextEntry

- (void) refreshMissionScreenTextEntry

Extends class PlayerEntity.

Definition at line 2491 of file PlayerEntityLegacyScriptEngine.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
    NSUInteger end_row = 21;
    if ([[self hud] allowBigGui]) 
    {
        end_row = 27;
    }
 
    [gui setText:[NSString stringWithFormat:DESC(@"mission-screen-text-prompt-@"), [gameView typedString]] forRow:end_row align:GUI_ALIGN_LEFT];
    [gui setColor:[OOColor cyanColor] forRow:end_row];
    
    [gui setShowTextCursor:YES];
    [gui setCurrentRow:end_row];
 
}

References OOColor::cyanColor, refreshMissionScreenTextEntry, GuiDisplayGen::setColor:forRow:, GuiDisplayGen::setCurrentRow:, GuiDisplayGen::setShowTextCursor:, GuiDisplayGen::setText:forRow:align:, and MyOpenGLView::typedString.

Referenced by refreshMissionScreenTextEntry.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAllCargo

- (void) removeAllCargo

Extends class PlayerEntity.

Definition at line 1387 of file PlayerEntityLegacyScriptEngine.m.

{
    [self removeAllCargo:NO];
}

References removeAllCargo, and PlayerEntity::removeAllCargo:.

Referenced by removeAllCargo, and removeAllCargo:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAllCargo:

- (void) removeAllCargo: (BOOL) forceRemoval

Extends class PlayerEntity.

Definition at line 1392 of file PlayerEntityLegacyScriptEngine.m.

                       :(BOOL)forceRemoval
{
    // Misnamed method. It only removes cargo measured in TONS, g & Kg items are not removed. --Kaks 20091004
    OOCommodityType          type;
    
    if (scriptTarget != self)  return;
    
    if ([self status] != STATUS_DOCKED && !forceRemoval)
    {
        OOLogWARN(kOOLogRemoveAllCargoNotDocked, @"%@removeAllCargo only works when docked.", [NSString stringWithFormat:@" in %@, ", CurrentScriptDesc()]);
        return;
    }
    
    OOLog(kOOLogNoteRemoveAllCargo, @"%@ removeAllCargo", forceRemoval ? @"Forcing" : @"Going to");
    
    foreach(type, [shipCommodityData goods])
    {
        if ([shipCommodityData massUnitForGood:type] == UNITS_TONS)
        {
            [shipCommodityData setQuantity:0 forGood:type];
        }
    }
 
 
    if (forceRemoval && [self status] != STATUS_DOCKED)
    {
        NSInteger i;
        for (i = [cargo count] - 1; i >= 0; i--)
        {
            ShipEntity* canister = [cargo objectAtIndex:i];
            if (!canister)  break;
            // Since we are forcing cargo removal, we don't really care about the unit of measurement. Any
            // commodity at more than 1000kg or 1000000gr will be inside cargopods, so remove those too.
            [cargo removeObjectAtIndex:i];
        }
    }
    
    DESTROY(specialCargo);
    
    [self calculateCurrentCargo];
}

References PlayerEntity::calculateCurrentCargo, count, DESTROY, kOOLogNoteRemoveAllCargo, kOOLogRemoveAllCargoNotDocked, OOLog, OOLogWARN, removeAllCargo, scriptTarget, and UNITS_TONS.

Here is the call graph for this function:

◆ removeEqScriptForKey:

- (void) removeEqScriptForKey: (NSString *) eq_key

Extends class PlayerEntity.

Definition at line 2887 of file PlayerEntityLegacyScriptEngine.m.

                             :(NSString *)eq_key
{
    if (eq_key == nil) return;
    
    NSString            *key = nil;
    NSUInteger          i, count = [eqScripts count];
    
    for (i = 0; i < count; i++)
    {
        key = [[eqScripts oo_arrayAtIndex:i] oo_stringAtIndex:0];
        if ([key isEqualToString: eq_key]) 
        {
            [eqScripts removeObjectAtIndex:i];
            
            if (i == primedEquipment)  primedEquipment = count;    // primed-none
            else if (i < primedEquipment)  primedEquipment--; // track the primed equipment
            if (count == primedEquipment)  primedEquipment--; // the array has shrunk by one!
 
            OOLog(@"player.equipmentScript", @"Removed equipment %@, with the following script property: '%@'.", eq_key, [[OOEquipmentType equipmentTypeWithIdentifier:eq_key] scriptName]);
        }
    }
}

References count, nil, and OOLog.

◆ removeEquipment:

- (void) removeEquipment: (NSString *) equipString

Extends class PlayerEntity.

Definition at line 1277 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)equipKey  //eg. EQ_NAVAL_ENERGY_UNIT
{
    if (scriptTarget != self)  return;
 
    if ([equipKey isEqualToString:@"EQ_FUEL"])
    {
        fuel = 0;
        return;
    }
    
    if ([equipKey isEqualToString:@"EQ_CARGO_BAY"] && [self hasEquipmentItem:equipKey]
            && ([self extraCargo] > [self availableCargoSpace]))
    {
        OOLog(kOOLogSyntaxRemoveEquipment, @"***** SCRIPT ERROR: in %@, CANNOT remove cargo bay. Too much cargo.", CurrentScriptDesc());
        return;
    }
    if ([self hasEquipmentItem:equipKey] || [self hasEquipmentItem:[equipKey stringByAppendingString:@"_DAMAGED"]])
    {
        [self removeEquipmentItem:equipKey];
    }
 
}

References kOOLogSyntaxRemoveEquipment, OOLog, PlayerEntity::removeEquipmentItem:, and scriptTarget.

Here is the call graph for this function:

◆ removeMissionDestination:

- (void) removeMissionDestination: (NSString *) destinations

Extends class PlayerEntity.

Definition at line 2134 of file PlayerEntityLegacyScriptEngine.m.

                                 :(NSString *)destinations
{
    unsigned            j;
    int                 dest;
    NSMutableArray      *tokens = ScanTokensFromString(destinations);
 
    for (j = 0; j < [tokens count]; j++)
    {
        dest = [[tokens objectAtIndex:j] intValue];
        if (dest < 0 || dest > 255)  continue;
 
        [self removeMissionDestinationMarker:[self defaultMarker:dest]];
    }
}

References PlayerEntity::defaultMarker:, PlayerEntity::removeMissionDestinationMarker:, and ScanTokensFromString().

Here is the call graph for this function:

◆ replaceVariablesInString:

- (NSString *) replaceVariablesInString: (NSString*) args

Extends class PlayerEntity.

Definition at line 782 of file PlayerEntityLegacyScriptEngine.m.

                                      :(NSString*) args
{
    NSMutableDictionary *locals = [self localVariablesForMission:sCurrentMissionKey];
    NSMutableString     *resultString = [NSMutableString stringWithString: args];
    NSString            *valueString;
    unsigned            i;
    NSMutableArray      *tokens = ScanTokensFromString(args);
    
    for (i = 0; i < [tokens  count]; i++)
    {
        valueString = [tokens objectAtIndex:i];
        
        if ([valueString hasPrefix:@"mission_"] && [mission_variables objectForKey:valueString])
        {
            [resultString replaceOccurrencesOfString:valueString withString:[mission_variables objectForKey:valueString] options:NSLiteralSearch range:NSMakeRange(0, [resultString length])];
        }
        else if ([locals objectForKey:valueString])
        {
            [resultString replaceOccurrencesOfString:valueString withString:[locals objectForKey:valueString] options:NSLiteralSearch range:NSMakeRange(0, [resultString length])];
        }
        else if (([valueString hasSuffix:@"_number"])||([valueString hasSuffix:@"_bool"])||([valueString hasSuffix:@"_string"]))
        {
            SEL valueselector = NSSelectorFromString(valueString);
            if ([self respondsToSelector:valueselector])
            {
                [resultString replaceOccurrencesOfString:valueString withString:[NSString stringWithFormat:@"%@", [self performSelector:valueselector]] options:NSLiteralSearch range:NSMakeRange(0, [resultString length])];
            }
        }
        else if ([valueString hasPrefix:@"["]&&[valueString hasSuffix:@"]"])
        {
            NSString* replaceString = OOExpand(valueString);
            [resultString replaceOccurrencesOfString:valueString withString:replaceString options:NSLiteralSearch range:NSMakeRange(0, [resultString length])];
        }
    }
    
    OOLog(kOOLogDebugReplaceVariablesInString, @"EXPANSION: \"%@\" becomes \"%@\"", args, resultString);
    
    return [NSString stringWithString: resultString];
}

References kOOLogDebugReplaceVariablesInString, PlayerEntity::localVariablesForMission:, OOExpand, OOLog, and ScanTokensFromString().

Here is the call graph for this function:

◆ reset:

- (void) reset: (NSString *) missionvariable

Extends class PlayerEntity.

Definition at line 1730 of file PlayerEntityLegacyScriptEngine.m.

              :(NSString *)missionvariable
{
    NSString*   missionVariableString = [missionvariable stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
    BOOL hasMissionPrefix, hasLocalPrefix;
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
 
    if (hasMissionPrefix)
    {
        [self setMissionVariable:nil forKey:missionVariableString];
    }
    else if (hasLocalPrefix)
    {
        [self setLocalVariable:nil forKey:missionVariableString andMission:sCurrentMissionKey];
    }
    else
    {
        OOLog(kOOLogSyntaxReset, @"***** SCRIPT ERROR: in %@, IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString);
    }
}

References kOOLogSyntaxReset, OOLog, PlayerEntity::setLocalVariable:forKey:andMission:, and PlayerEntity::setMissionVariable:forKey:.

Here is the call graph for this function:

◆ resetMissionChoice

- (void) resetMissionChoice

Extends class PlayerEntity.

Definition at line 2100 of file PlayerEntityLegacyScriptEngine.m.

{
    [self setMissionChoice:nil];
}

References resetMissionChoice, and PlayerEntity::setMissionChoice:.

Referenced by resetMissionChoice.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetScriptTimer

- (void) resetScriptTimer

Extends class PlayerEntity.

Definition at line 1893 of file PlayerEntityLegacyScriptEngine.m.

{
    script_time = 0.0;
    script_time_check = SCRIPT_TIMER_INTERVAL;
    script_time_interval = SCRIPT_TIMER_INTERVAL;
}

References resetScriptTimer, and SCRIPT_TIMER_INTERVAL.

Referenced by resetScriptTimer.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ runScriptActions:withContextName:forTarget:

- (void) runScriptActions:	(NSArray *)	sanitizedActions
withContextName:	(NSString *)	contextName
forTarget:	(ShipEntity *)	target

Extends class PlayerEntity.

Definition at line 361 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSArray *)actions withContextName:(NSString *)contextName forTarget:(ShipEntity *)target
{
    NSAutoreleasePool       *pool = nil;
    NSString                *oldMissionKey = nil;
    NSString * volatile     theMissionKey = contextName;    // Work-around for silly exception macros
    
    pool = [[NSAutoreleasePool alloc] init];
    
    // FIXME: does this actually make sense in the context of non-missions?
    oldMissionKey = sCurrentMissionKey;
    sCurrentMissionKey = theMissionKey;
    
    @try
    {
        PerformScriptActions(actions, target);
    }
    @catch (NSException *exception)
    {
        OOLog(@"script.error.exception",
              @"***** EXCEPTION %@: %@ while handling legacy script actions for %@",
              [exception name],
              [exception reason],
              [theMissionKey hasPrefix:kActionTempPrefix] ? [target shortDescription] : theMissionKey);
        // Suppress exception
    }
    
    sCurrentMissionKey = oldMissionKey;
    [pool release];
}

References kActionTempPrefix, nil, OOLog, PerformScriptActions, and sCurrentMissionKey.

Here is the call graph for this function:

◆ runUnsanitizedScriptActions:allowingAIMethods:withContextName:forTarget:

- (void) runUnsanitizedScriptActions:	(NSArray *)	unsanitizedActions
allowingAIMethods:	(BOOL)	allowAIMethods
withContextName:	(NSString *)	contextName
forTarget:	(ShipEntity *)	target

Extends class PlayerEntity.

Definition at line 392 of file PlayerEntityLegacyScriptEngine.m.

                                    :(NSArray *)actions allowingAIMethods:(BOOL)allowAIMethods withContextName:(NSString *)contextName forTarget:(ShipEntity *)target
{
    [self runScriptActions:OOSanitizeLegacyScript(actions, contextName, allowAIMethods)
           withContextName:contextName
                 forTarget:target];
}

References PlayerEntity::runScriptActions:withContextName:forTarget:.

Here is the call graph for this function:

◆ score_number

- (NSNumber *) score_number

Extends class PlayerEntity.

Definition at line 937 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithUnsignedInt:[self score]];
}

References PlayerEntity::score, and score_number.

Referenced by score_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scriptTarget

- (ShipEntity *) scriptTarget

Extends class PlayerEntity.

Definition at line 254 of file PlayerEntityLegacyScriptEngine.m.

{
    return scriptTarget;
}

References scriptTarget.

Referenced by awardCargo:, awardCredits:, awardEquipment:, awardShipKills:, ejectItem:, removeAllCargo:, removeEquipment:, scriptTarget, setFuelLeak:, setScriptTarget:, and useSpecialCargo:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scriptTestCondition:

- (BOOL) scriptTestCondition: (NSArray *) scriptCondition

implementation

Extends class PlayerEntity.

Definition at line 421 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;
}

◆ scriptTestConditions:

- (BOOL) scriptTestConditions: (NSArray *) array

Extends class PlayerEntity.

Definition at line 400 of file PlayerEntityLegacyScriptEngine.m.

                             :(NSArray *)array
{
    BOOL                result = NO;
    
    @try
    {
        result = TestScriptConditions(array);
    }
    @catch (NSException *exception)
    {
        OOLog(@"script.error.exception",
              @"***** EXCEPTION %@: %@ while testing legacy script conditions.",
              [exception name],
              [exception reason]);
        // Suppress exception
    }
    
    return result;
}

References OOLog, and TestScriptConditions.

Here is the call graph for this function:

◆ scriptTimer_number

- (NSNumber *) scriptTimer_number

Extends class PlayerEntity.

Definition at line 949 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithDouble:[self scriptTimer]];
}

References PlayerEntity::scriptTimer, and scriptTimer_number.

Referenced by scriptTimer_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendAllShipsAway

- (void) sendAllShipsAway

Extends class PlayerEntity.

Definition at line 2269 of file PlayerEntityLegacyScriptEngine.m.

{
    if (!UNIVERSE)
        return;
    int         ent_count =     UNIVERSE->n_entities;
    Entity**    uni_entities =  UNIVERSE->sortedEntities;   // grab the public sorted list
    Entity*     my_entities[ent_count];
    int i;
    for (i = 0; i < ent_count; i++)
        my_entities[i] = [uni_entities[i] retain];      //  retained
 
    for (i = 1; i < ent_count; i++)
    {
        Entity* e1 = my_entities[i];
        if ([e1 isShip])
        {
            ShipEntity* se1 = (ShipEntity*)e1;
            int e_class = [e1 scanClass];
            if (((e_class == CLASS_NEUTRAL)||(e_class == CLASS_POLICE)||(e_class == CLASS_MILITARY)||(e_class == CLASS_THARGOID)) &&
                                            ! ([se1 isStation] && [se1 maxFlightSpeed] == 0) &&  // exclude only stations, not carriers.
                                            [se1 hasHyperspaceMotor]) // exclude non jumping ships. Escorts will still be able to follow a mother.
            {
                AI* se1AI = [se1 getAI];
                [se1 setFuel:MAX(PLAYER_MAX_FUEL, [se1 fuelCapacity])];
                [se1 setAITo:@"exitingTraderAI.plist"];  // lets them return to their previous state after the jump
                [se1AI setState:@"EXIT_SYSTEM"];
                // The following should prevent all ships leaving at once (freezes oolite on slower machines)
                [se1AI setNextThinkTime:[UNIVERSE getTime] + 3 + (ranrot_rand() & 15)];
                [se1 setPrimaryRole:@"oolite-none"];  // prevents new ship from appearing at witchpoint when this one leaves!
            }
        }
    }
    
    for (i = 0; i < ent_count; i++)
    {
        [my_entities[i] release];       //  released
    }
}

References ShipEntity::fuelCapacity, ShipEntity::getAI, Entity::scanClass, sendAllShipsAway, ShipEntity::setAITo:, ShipEntity::setFuel:, AI::setNextThinkTime:, ShipEntity::setPrimaryRole:, AI::setState:, and UNIVERSE.

Referenced by sendAllShipsAway.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set:

- (void) set: (NSString *) missionvariable_value

Extends class PlayerEntity.

Definition at line 1691 of file PlayerEntityLegacyScriptEngine.m.

            :(NSString *)missionvariable_value
{
    NSMutableArray      *tokens = ScanTokensFromString(missionvariable_value);
    NSString            *missionVariableString = nil;
    NSString            *valueString = nil;
    BOOL                hasMissionPrefix, hasLocalPrefix;
 
    if ([tokens count] < 2)
    {
        OOLog(kOOLogSyntaxSet, @"***** SCRIPT ERROR: in %@, CANNOT SET '%@' (expected mission_variable or local_variable followed by value expression)", CurrentScriptDesc(), missionvariable_value);
        return;
    }
 
    missionVariableString = [tokens objectAtIndex:0];
    [tokens removeObjectAtIndex:0];
    valueString = [tokens componentsJoinedByString:@" "];
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
 
    if (!hasMissionPrefix && !hasLocalPrefix)
    {
        OOLog(kOOLogSyntaxSet, @"***** SCRIPT ERROR: in %@, IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString);
        return;
    }
 
    OOLog(kOOLogNoteSet, @"DEBUG: script %@ is set to %@", missionVariableString, valueString);
    
    if (hasMissionPrefix)
    {
        [self setMissionVariable:valueString forKey:missionVariableString];
    }
    else
    {
        [self setLocalVariable:valueString forKey:missionVariableString andMission:sCurrentMissionKey];
    }
}

References count, kOOLogNoteSet, kOOLogSyntaxSet, nil, OOLog, ScanTokensFromString(), PlayerEntity::setLocalVariable:forKey:andMission:, and PlayerEntity::setMissionVariable:forKey:.

Here is the call graph for this function:

◆ setBackgroundFromDescriptionsKey:

- (void) setBackgroundFromDescriptionsKey: (NSString*) d_key

Extends class PlayerEntity.

Definition at line 2572 of file PlayerEntityLegacyScriptEngine.m.

                                         :(NSString*) d_key
{
    NSArray * items = (NSArray *)[[UNIVERSE descriptions] objectForKey:d_key];
    //
    if (!items)
        return;
    //
    [self addScene: items atOffset: kZeroVector];
    //
    [self setShowDemoShips: YES];
}

References PlayerEntity::addScene:atOffset:, PlayerEntity::setShowDemoShips:, and UNIVERSE.

Here is the call graph for this function:

◆ setFuelLeak:

- (void) setFuelLeak: (NSString *) value

Extends class PlayerEntity.

Definition at line 2216 of file PlayerEntityLegacyScriptEngine.m.

                    :(NSString *)value
{   
    if (scriptTarget != self)
    {
        [scriptTarget setFuel:0];
        return;
    }
    
    fuel_leak_rate = [value doubleValue];
    if (fuel_leak_rate > 0)
    {
        [self playFuelLeak];
        [UNIVERSE addMessage:DESC(@"danger-fuel-leak") forCount:6];
        OOLog(kOOLogNoteFuelLeak, @"%@", @"FUEL LEAK activated!");
    }
}

References kOOLogNoteFuelLeak, OOLog, PlayerEntity::playFuelLeak, scriptTarget, and ShipEntity::setFuel:.

Here is the call graph for this function:

◆ setGalacticHyperspaceBehaviourTo:

- (void) setGalacticHyperspaceBehaviourTo: (NSString *) galacticHyperspaceBehaviourString

Extends class PlayerEntity.

Definition at line 2954 of file PlayerEntityLegacyScriptEngine.m.

                                         :(NSString *)galacticHyperspaceBehaviourString
{
    OOGalacticHyperspaceBehaviour ghBehaviour = OOGalacticHyperspaceBehaviourFromString(galacticHyperspaceBehaviourString);
    if (ghBehaviour == GALACTIC_HYPERSPACE_BEHAVIOUR_UNKNOWN)
    {
        OOLog(@"player.setGalacticHyperspaceBehaviour.invalidInput",
              @"setGalacticHyperspaceBehaviourTo: called with unknown behaviour %@.", galacticHyperspaceBehaviourString);
    }
    [self setGalacticHyperspaceBehaviour:ghBehaviour];
}

References OOGalacticHyperspaceBehaviourFromString(), OOLog, and PlayerEntity::setGalacticHyperspaceBehaviour:.

Here is the call graph for this function:

◆ setGalacticHyperspaceFixedCoordsTo:

- (void) setGalacticHyperspaceFixedCoordsTo: (NSString *) galacticHyperspaceFixedCoordsString

Extends class PlayerEntity.

Definition at line 2966 of file PlayerEntityLegacyScriptEngine.m.

                                           :(NSString *)galacticHyperspaceFixedCoordsString
{   
    NSArray *coord_vals = ScanTokensFromString(galacticHyperspaceFixedCoordsString);
    if ([coord_vals count] < 2)    // Will be 0 if string is nil
    {
        OOLog(@"player.setGalacticHyperspaceFixedCoords.invalidInput", @"%@",
              @"setGalacticHyperspaceFixedCoords: called with bad specifier. Defaulting to Oolite standard.");
        galacticHyperspaceFixedCoords.x = galacticHyperspaceFixedCoords.y = 0x60;
    }
    
    [self setGalacticHyperspaceFixedCoordsX:[coord_vals oo_unsignedCharAtIndex:0]
                                          y:[coord_vals oo_unsignedCharAtIndex:1]];
}

References count, OOLog, ScanTokensFromString(), and PlayerEntity::setGalacticHyperspaceFixedCoordsX:y:.

Here is the call graph for this function:

◆ setGuiToMissionScreen

- (void) setGuiToMissionScreen

Extends class PlayerEntity.

Definition at line 2479 of file PlayerEntityLegacyScriptEngine.m.

{
    // reset special background as legacy scripts can't use it, and this
    // is only called by legacy scripts
    [self setMissionBackgroundSpecial:nil];
    // likewise exit screen target
    [self setMissionExitScreen:GUI_SCREEN_STATUS];
 
    [self setGuiToMissionScreenWithCallback:NO];
}

References setGuiToMissionScreen, PlayerEntity::setGuiToMissionScreenWithCallback:, PlayerEntity::setMissionBackgroundSpecial:, and PlayerEntity::setMissionExitScreen:.

Referenced by setGuiToMissionScreen.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setGuiToMissionScreenWithCallback:

- (void) setGuiToMissionScreenWithCallback: (BOOL) callback

Extends class PlayerEntity.

Definition at line 2510 of file PlayerEntityLegacyScriptEngine.m.

                                          :(BOOL) callback
{
    GuiDisplayGen   *gui = [UNIVERSE gui];
    OOGUIScreenID  oldScreen = gui_screen;
    NSUInteger end_row = 21;
    if ([[self hud] allowBigGui]) 
    {
        end_row = 27;
    }
 
    // GUI stuff
    {
        [gui clear];
        [gui setTitle:[self missionTitle] ?: DESC(@"mission-information")];
        
        if (!_missionTextEntry)
        {
            [gui setText:DESC(@"press-space-commander") forRow:end_row align:GUI_ALIGN_CENTER];
            [gui setColor:[OOColor yellowColor] forRow:end_row];
            [gui setKey:@"spacebar" forRow:end_row];
            [gui setShowTextCursor:NO];
        }
        else
        {
            [self refreshMissionScreenTextEntry];
        }
        [gui setSelectableRange:NSMakeRange(0,0)];
        
        [gui setForegroundTextureDescriptor:[self missionOverlayDescriptorOrDefault]];
        NSDictionary *background_desc = [self missionBackgroundDescriptorOrDefault];
        [gui setBackgroundTextureDescriptor:background_desc];
        // must set special second as setting the descriptor resets it
        BOOL overridden = ([self missionBackgroundDescriptor] != nil);
        [gui setBackgroundTextureSpecial:[self missionBackgroundSpecial] withBackground:!overridden];
        
 
    }
    /* ends */
 
    missionTextRow = 1;
 
    
    if (gui)
        gui_screen = GUI_SCREEN_MISSION;
 
    if (lastTextKey)
    {
        [lastTextKey release];
        lastTextKey = nil;
    }
    
    [[OOMusicController sharedController] playMissionMusic];
    
    // the following are necessary...
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO];
    _missionWithCallback = callback;
    _missionAllowInterrupt = NO;
    [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
 
}

Here is the call graph for this function:

◆ setLegalStatus:

- (void) setLegalStatus: (NSString *) valueString

Extends class PlayerEntity.

Definition at line 968 of file PlayerEntityLegacyScriptEngine.m.

                       :(NSString *)valueString
{
    legalStatus = [valueString intValue];
}

◆ setLocalVariable:forKey:andMission:

- (void) setLocalVariable:	(NSString *)	value
forKey:	(NSString *)	variableName
andMission:	(NSString *)	missionKey

Extends class PlayerEntity.

Definition at line 692 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)value forKey:(NSString *)variableName andMission:(NSString *)missionKey
{
    NSMutableDictionary     *locals = nil;
    
    if (variableName != nil && missionKey != nil)
    {
        locals = [self localVariablesForMission:missionKey];
        if (value != nil)
        {
            [locals setObject:value forKey:variableName];
        }
        else
        {
            [locals removeObjectForKey:variableName];
        }
    }
}

References PlayerEntity::localVariablesForMission:, and nil.

Here is the call graph for this function:

◆ setMissionBackground:

- (void) setMissionBackground: (NSString *) value

implementation

Extends class PlayerEntity.

Definition at line 2203 of file PlayerEntityLegacyScriptEngine.m.

                             :(NSString *)value
{
    if ([value length] != 0 && ![[value lowercaseString] isEqualToString:@"none"])
    {
        [self setMissionBackgroundDescriptor:[NSDictionary dictionaryWithObject:value forKey:@"name"]];
    }
    else
    {
        [self setMissionBackgroundDescriptor:nil];
    }
}

References PlayerEntity::setMissionBackgroundDescriptor:.

Here is the call graph for this function:

◆ setMissionChoiceByTextEntry:

- (void) setMissionChoiceByTextEntry: (BOOL) enable

Extends class PlayerEntity.

Definition at line 1934 of file PlayerEntityLegacyScriptEngine.m.

                                    :(BOOL)enable
{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    _missionTextEntry = enable;
    [gameView resetTypedString];
}

References MyOpenGLView::resetTypedString.

Here is the call graph for this function:

◆ setMissionChoices:

- (void) setMissionChoices: (NSString *) choicesKey

Extends class PlayerEntity.

Definition at line 1942 of file PlayerEntityLegacyScriptEngine.m.

                          :(NSString *)choicesKey   // choicesKey is a key for a dictionary of
{                                                   // choices/choice phrases in missiontext.plist and also..
    NSDictionary *choicesDict = [[UNIVERSE missiontext] oo_dictionaryForKey:choicesKey];
    if ([choicesDict count] == 0)
    {
        return;
    }
    [self setMissionChoicesDictionary:choicesDict];
}

References count, and PlayerEntity::setMissionChoicesDictionary:.

Here is the call graph for this function:

◆ setMissionChoicesDictionary:

- (void) setMissionChoicesDictionary: (NSDictionary *) choicesDict

Extends class PlayerEntity.

Definition at line 1953 of file PlayerEntityLegacyScriptEngine.m.

                                    :(NSDictionary *)choicesDict
{
    unsigned i;
    bool keysOK = true;
    GuiDisplayGen* gui = [UNIVERSE gui];
    // TODO: MORE STUFF HERE
    //
    // What it does now:
    // find list of choices in missiontext.plist
    // add them to gui setting the key for each line to the key in the dict of choices
    // and the text of the line to the value in the dict of choices
    // and also set the selectable range
    // ++ change the mission screen's response to wait for a choice
    // and only if the selectable range is not present ask:
    // Press Space Commander...
    //
    
    NSUInteger end_row = 21;
    if ([[self hud] allowBigGui]) 
    {
        end_row = 27;
    }
 
    NSArray *choiceKeys = [choicesDict allKeys];
    /* Guard against potential for numeric keys in dictionary, which
     * would cause an unhandled exception in the sorter. See
     * OOJavaScriptEngine::OOJSDictionaryFromJSObject for further
     * thoughts. - CIM 15/2/13 */
    for (i=0; i < [choiceKeys count]; i++)
    {
        if (![[choiceKeys objectAtIndex:i] isKindOfClass:[NSString class]])
        {
            OOLog(@"test.script.error",@"Choices list in mission screen has non-string value %@",[choiceKeys objectAtIndex:i]);
            keysOK = false;
        }
    }   
    if (keysOK)
    {
        // only try this if they're all strings
        choiceKeys = [choiceKeys sortedArrayUsingSelector:@selector(caseInsensitiveCompare:)];
    }
 
    NSInteger keysCount = [choiceKeys count];
    if ((end_row + 1) < [choiceKeys count]) {
        OOLogERR(kOOLogException, @"in mission.runScreen choices: number of choices defined (%i) is greater than available lines (%i). Check HUD settings for allowBigGui.",  [choiceKeys count], (end_row + 1));
        keysCount = end_row + 1;
    }
 
    [gui setText:@"" forRow:end_row];              // clears out the 'Press spacebar' message
    [gui setKey:@"" forRow:end_row];                    // clears the key to enable pollDemoControls to check for a selection
    [gui setSelectableRange:NSMakeRange(0,0)];    // clears the selectable range
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES]; // enables mouse selection of the choices list items
    
    OOGUIRow            choicesRow = (end_row+1) - keysCount;
    NSEnumerator        *choiceEnum = nil;
    NSString            *choiceKey = nil;
    id                  choiceValue = nil;
    NSString            *choiceText = nil;
    
    BOOL selectableRowExists = NO;
    NSUInteger firstSelectableRow = end_row;
 
    for (choiceEnum = [choiceKeys objectEnumerator]; (choiceKey = [choiceEnum nextObject]); )
    {
        choiceValue = [choicesDict objectForKey:choiceKey];
        OOGUIAlignment alignment = GUI_ALIGN_CENTER;
        OOColor *rowColor = [OOColor yellowColor];
        BOOL selectable = YES;
        if ([choiceValue isKindOfClass:[NSString class]])
        {
            choiceText = [NSString stringWithFormat:@" %@ ",(NSString*)choiceValue];
        } 
        else if ([choiceValue isKindOfClass:[NSDictionary class]])
        {
            NSDictionary *choiceOpts = (NSDictionary*)choiceValue;
            choiceText = [NSString stringWithFormat:@" %@ ",[choiceOpts oo_stringForKey:@"text"]];
            NSString *alignmentChoice = [choiceOpts oo_stringForKey:@"alignment" defaultValue:@"CENTER"];
            if ([alignmentChoice isEqualToString:@"LEFT"])
            {
                alignment = GUI_ALIGN_LEFT;
            }
            else if ([alignmentChoice isEqualToString:@"RIGHT"])
            {
                alignment = GUI_ALIGN_RIGHT;
            }
            id colorDesc = [choiceOpts objectForKey:@"color"];
            if ([choiceOpts oo_boolForKey:@"unselectable"])
            {
                selectable = NO;
            }
            if (colorDesc != nil)
            {
                rowColor = [OOColor colorWithDescription:colorDesc];
            }
            else if (!selectable) // different default
            {
                rowColor = [OOColor darkGrayColor];
            }
        }
        else
        {
            continue; // invalid type
        }
        choiceText = OOExpand(choiceText);
        choiceText = [self replaceVariablesInString:choiceText];
        // allow blank rows
        if (![choiceText isEqualToString:@"  "])
        {
            [gui setText:choiceText forRow:choicesRow align: alignment];
            if (selectable)
            {
                [gui setKey:choiceKey forRow:choicesRow];
            }
            else
            {
                [gui setKey:GUI_KEY_SKIP forRow:choicesRow];
            }
            [gui setColor:rowColor forRow:choicesRow];
            if (selectable && !selectableRowExists)
            {
                selectableRowExists = YES;
                firstSelectableRow = choicesRow;
            }
        }
        else 
        {
            [gui setKey:GUI_KEY_SKIP forRow:choicesRow];
        }
        choicesRow++;
        if (choicesRow > (end_row + 1)) break;
    }
    
    if (!selectableRowExists)
    {
        // just in case choices are set but they're all blank.
        [gui setText:@"  " forRow:end_row align: GUI_ALIGN_CENTER];
        [gui setKey:@"" forRow:end_row];
        [gui setColor:[OOColor yellowColor] forRow:end_row];
    }
 
    [gui setSelectableRange:NSMakeRange((end_row+1) - keysCount, keysCount)];
    [gui setSelectedRow: firstSelectableRow];
    
    [self resetMissionChoice];
}

References OOColor::colorWithDescription:, count, OOColor::darkGrayColor, GUI_ALIGN_CENTER, GUI_ALIGN_LEFT, GUI_ALIGN_RIGHT, kOOLogException, nil, OOExpand, OOLog, OOLogERR, PlayerEntity::replaceVariablesInString:, PlayerEntity::resetMissionChoice, GuiDisplayGen::setColor:forRow:, GuiDisplayGen::setKey:forRow:, GuiDisplayGen::setSelectableRange:, GuiDisplayGen::setSelectedRow:, GuiDisplayGen::setText:forRow:, GuiDisplayGen::setText:forRow:align:, and OOColor::yellowColor.

Here is the call graph for this function:

◆ setMissionDescription:

- (void) setMissionDescription: (NSString *) textKey

Extends class PlayerEntity.

Definition at line 825 of file PlayerEntityLegacyScriptEngine.m.

                              :(NSString *)textKey
{
    [self setMissionDescription:textKey forMission:sCurrentMissionKey];
}

References PlayerEntity::setMissionDescription:forMission:.

Here is the call graph for this function:

◆ setMissionDescription:forMission:

- (void) setMissionDescription:		(NSString *)	textKey
forMission:		(NSString *)	key

Extends class PlayerEntity.

Definition at line 831 of file PlayerEntityLegacyScriptEngine.m.

                              :(NSString *)textKey forMission:(NSString *)key
{
    NSString        *text = [[UNIVERSE missiontext] oo_stringForKey:textKey];
    
    if (!text)
    {
        OOLogERR(kOOLogScriptMissionDescNoText, @"in %@, no mission text set for key '%@' [UNIVERSE missiontext] is:\n%@ ", CurrentScriptDesc(), textKey, [UNIVERSE missiontext]);
        return;
    }
    
    [self setMissionInstructions:text forMission:key];
}

References kOOLogScriptMissionDescNoText, OOLogERR, PlayerEntity::setMissionInstructions:forMission:, and UNIVERSE.

Here is the call graph for this function:

◆ setMissionImage:

- (void) setMissionImage: (NSString *) value

implementation

Extends class PlayerEntity.

Definition at line 2189 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)value
{
    if ([value length] != 0 && ![[value lowercaseString] isEqualToString:@"none"])
    {
        [self setMissionOverlayDescriptor:[NSDictionary dictionaryWithObject:value forKey:@"name"]];
    }
    else
    {
        [self setMissionOverlayDescriptor:nil];
    }
 
}

References PlayerEntity::setMissionOverlayDescriptor:.

Here is the call graph for this function:

◆ setMissionInstructions:forMission:

- (void) setMissionInstructions:		(NSString *)	text
forMission:		(NSString *)	key

Extends class PlayerEntity.

Definition at line 846 of file PlayerEntityLegacyScriptEngine.m.

                               :(NSString *)text forMission:(NSString *)key
{
    if (!key)
    {
        OOLogERR(kOOLogScriptMissionDescNoKey, @"in %@, mission key not set", CurrentScriptDesc());
        return;
    }
 
    text = OOExpand(text);
    text = [self replaceVariablesInString: text];
 
    [mission_variables setObject:text forKey:key];
}

References kOOLogScriptMissionDescNoKey, OOExpand, OOLogERR, and PlayerEntity::replaceVariablesInString:.

Here is the call graph for this function:

◆ setMissionInstructionsList:forMission:

- (void) setMissionInstructionsList:		(NSArray *)	list
forMission:		(NSString *)	key

Extends class PlayerEntity.

Definition at line 861 of file PlayerEntityLegacyScriptEngine.m.

                                   :(NSArray *)list forMission:(NSString *)key
{
    if (!key)
    {
        OOLogERR(kOOLogScriptMissionDescNoKey, @"in %@, mission key not set", CurrentScriptDesc());
        return;
    }
 
    NSString *text = nil;
    NSUInteger i,ct = [list count];
    NSMutableArray *expandedList = [NSMutableArray arrayWithCapacity:ct];
    for (i=0 ; i<ct ; i++)
    {
        text = [list oo_stringAtIndex:i defaultValue:nil];
        if (text != nil)
        {
            text = OOExpand(text);
            text = [self replaceVariablesInString: text];
            [expandedList addObject:text];
        }
    }
 
    [mission_variables setObject:expandedList forKey:key];
}

References kOOLogScriptMissionDescNoKey, nil, OOExpand, OOLogERR, and PlayerEntity::replaceVariablesInString:.

Here is the call graph for this function:

◆ setMissionMusic:

- (void) setMissionMusic: (NSString *) value

Extends class PlayerEntity.

Definition at line 2163 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)value
{
    if ([value length] == 0 || [[value lowercaseString] isEqualToString:@"none"])
    {
        value = nil;
    }
    [[OOMusicController    sharedController] setMissionMusic:value];
}

References nil, OOMusicController::setMissionMusic:, and OOMusicController::sharedController.

Here is the call graph for this function:

◆ setMissionScreenID:

- (void) setMissionScreenID: (NSString *) msid

Extends class PlayerEntity.

Definition at line 2454 of file PlayerEntityLegacyScriptEngine.m.

                           :(NSString *)msid
{
    _missionScreenID = [msid retain];
}

◆ setMissionTitle:

- (void) setMissionTitle: (NSString *) value

Extends class PlayerEntity.

Definition at line 2179 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)value
{
    if (_missionTitle != value)
    {
        [_missionTitle release];
        _missionTitle = [value copy];
    }
}

◆ setMissionVariable:forKey:

- (void) setMissionVariable:		(NSString *)	value
forKey:		(NSString *)	key

Extends class PlayerEntity.

Definition at line 659 of file PlayerEntityLegacyScriptEngine.m.

                          :(NSString *)value forKey:(NSString *)key
{
    if (key != nil)
    {
        if (value != nil)  [mission_variables setObject:value forKey:key];
        else [mission_variables removeObjectForKey:key];
    }
}

References nil.

◆ setPlanetinfo:

- (void) setPlanetinfo: (NSString *) key_valueString

Extends class PlayerEntity.

Definition at line 1301 of file PlayerEntityLegacyScriptEngine.m.

                      :(NSString *)key_valueString  // uses key=value format
{
    NSArray *   tokens = [key_valueString componentsSeparatedByString:@"="];
    NSString*   keyString = nil;
    NSString*   valueString = nil;
 
    if ([tokens count] != 2)
    {
        OOLog(kOOLogSyntaxSetPlanetInfo, @"***** SCRIPT ERROR: in %@, CANNOT setPlanetinfo: '%@' (bad parameter count)", CurrentScriptDesc(), key_valueString);
        return;
    }
    
    keyString = [[tokens objectAtIndex:0] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
    valueString = [[tokens objectAtIndex:1] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
    
    /* Legacy script planetinfo settings are now non-persistent over save/load
     * Virtually nothing uses them any more, and expecting them to have a
     * manifest and identifying what it is if so seems unnecessary */
    [UNIVERSE setSystemDataKey:keyString value:valueString fromManifest:@""];
 
}

References count, kOOLogSyntaxSetPlanetInfo, nil, and OOLog.

◆ setScriptTarget:

- (void) setScriptTarget: (ShipEntity *) ship

Extends class PlayerEntity.

Definition at line 248 of file PlayerEntityLegacyScriptEngine.m.

                        :(ShipEntity *)ship
{
    scriptTarget = ship;
}

References scriptTarget.

Here is the call graph for this function:

◆ setSpecificPlanetInfo:

- (void) setSpecificPlanetInfo: (NSString *) key_valueString

Extends class PlayerEntity.

Definition at line 1324 of file PlayerEntityLegacyScriptEngine.m.

                              :(NSString *)key_valueString  // uses galaxy#=planet#=key=value
{
    NSArray *   tokens = [key_valueString componentsSeparatedByString:@"="];
    NSString*   keyString = nil;
    NSString*   valueString = nil;
    int gnum, pnum;
 
    if ([tokens count] != 4)
    {
        OOLog(kOOLogSyntaxSetPlanetInfo, @"***** SCRIPT ERROR: in %@, CANNOT setSpecificPlanetInfo: '%@' (bad parameter count)", CurrentScriptDesc(), key_valueString);
        return;
    }
 
    gnum = [tokens oo_intAtIndex:0];
    pnum = [tokens oo_intAtIndex:1];
    keyString = [[tokens objectAtIndex:2] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
    valueString = [[tokens objectAtIndex:3] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
 
    [UNIVERSE setSystemDataForGalaxy:gnum planet:pnum key:keyString value:valueString fromManifest:@"" forLayer:OO_LAYER_OXP_DYNAMIC];
}

References count, kOOLogSyntaxSetPlanetInfo, nil, and OOLog.

◆ setSunNovaIn:

- (void) setSunNovaIn: (NSString *) time_value

Extends class PlayerEntity.

Definition at line 2240 of file PlayerEntityLegacyScriptEngine.m.

                     :(NSString *)time_value
{
    double time_until_nova = [time_value doubleValue];
    [[UNIVERSE sun] setGoingNova:YES inTime: time_until_nova];
}

◆ shipsFound_number

- (NSNumber *) shipsFound_number

Extends class PlayerEntity.

Definition at line 956 of file PlayerEntityLegacyScriptEngine.m.

{
    return [NSNumber numberWithInt:shipsFound];
}

References shipsFound_number.

Referenced by shipsFound_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showShipModel:

- (void) showShipModel: (NSString *) shipKey

Extends class PlayerEntity.

Definition at line 2150 of file PlayerEntityLegacyScriptEngine.m.

                      :(NSString *)role
{
    if ([role isEqualToString:@"none"] || [role length] == 0)
    {
        [UNIVERSE removeDemoShips];
        return;
    }
    
    ShipEntity *ship = [UNIVERSE makeDemoShipWithRole:role spinning:YES];
    OOLog(kOOLogNoteShowShipModel, @"::::: showShipModel:'%@' (%@) (%@)", role, ship, [ship name]);
}

References kOOLogNoteShowShipModel, and OOLog.

◆ spawnShip:

- (void) spawnShip: (NSString *) ship_key

Extends class PlayerEntity.

Definition at line 1678 of file PlayerEntityLegacyScriptEngine.m.

                  :(NSString *)ship_key
{
    if ([UNIVERSE spawnShip:ship_key])
    {
        OOLog(kOOLogNoteAddShips, @"DEBUG: Spawned ship with shipdata key '%@'.", ship_key);
    }
    else
    {
        OOLog(kOOLogScriptAddShipsFailed, @"***** SCRIPT ERROR: in %@, could not spawn ship with shipdata key '%@'.", CurrentScriptDesc(), ship_key);
    }
}

References kOOLogNoteAddShips, kOOLogScriptAddShipsFailed, OOLog, and UNIVERSE.

◆ status_string

- (NSString *) status_string

Extends class PlayerEntity.

Definition at line 913 of file PlayerEntityLegacyScriptEngine.m.

{
    return OOStringFromEntityStatus([self status]);
}

References OOStringFromEntityStatus(), and status_string.

Referenced by status_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subtract:

- (void) subtract: (NSString *) missionVariableString_value

Extends class PlayerEntity.

Definition at line 1847 of file PlayerEntityLegacyScriptEngine.m.

                 :(NSString *)missionVariableString_value
{
    NSString*   missionVariableString = nil;
    NSString*   valueString;
    double  value;
    NSMutableArray* tokens = ScanTokensFromString(missionVariableString_value);
    BOOL hasMissionPrefix, hasLocalPrefix;
 
    if ([tokens count] < 2)
    {
        OOLog(kOOLogSyntaxSubtract, @"***** SCRIPT ERROR: in %@, CANNOT SUBTRACT: '%@'", CurrentScriptDesc(), missionVariableString_value);
        return;
    }
 
    missionVariableString = [tokens objectAtIndex:0];
    [tokens removeObjectAtIndex:0];
    valueString = [tokens componentsJoinedByString:@" "];
 
    hasMissionPrefix = [missionVariableString hasPrefix:@"mission_"];
    hasLocalPrefix = [missionVariableString hasPrefix:@"local_"];
    
    if (hasMissionPrefix)
    {
        value = [[self missionVariableForKey:missionVariableString] doubleValue];
        value -= [valueString doubleValue];
        [self setMissionVariable:[NSString stringWithFormat:@"%f", value] forKey:missionVariableString];
    }
    else if (hasLocalPrefix)
    {
        value = [[self localVariableForKey:missionVariableString andMission:sCurrentMissionKey] doubleValue];
        value -= [valueString doubleValue];
        [self setLocalVariable:[NSString stringWithFormat:@"%f", value] forKey:missionVariableString andMission:sCurrentMissionKey];
    }
    else
    {
        OOLog(kOOLogSyntaxSubtract, @"***** SCRIPT ERROR: in %@, CANNOT SUBTRACT: '%@' -- IDENTIFIER '%@' DOES NOT BEGIN WITH 'mission_' or 'local_'", CurrentScriptDesc(), missionVariableString_value, missionVariableString_value);
    }
}

References count, kOOLogSyntaxSubtract, PlayerEntity::localVariableForKey:andMission:, PlayerEntity::missionVariableForKey:, nil, OOLog, ScanTokensFromString(), PlayerEntity::setLocalVariable:forKey:andMission:, and PlayerEntity::setMissionVariable:forKey:.

Here is the call graph for this function:

◆ sunGoneNova_bool

- (NSString *) sunGoneNova_bool

Extends class PlayerEntity.

Definition at line 1061 of file PlayerEntityLegacyScriptEngine.m.

{
    return ([[UNIVERSE sun] goneNova])? @"YES" : @"NO";
}

References sunGoneNova_bool, and UNIVERSE.

Referenced by sunGoneNova_bool.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sunWillGoNova_bool

- (NSString *) sunWillGoNova_bool

Extends class PlayerEntity.

Definition at line 1055 of file PlayerEntityLegacyScriptEngine.m.

{
    return ([[UNIVERSE sun] willGoNova])? @"YES" : @"NO";
}

References sunWillGoNova_bool, and UNIVERSE.

Referenced by sunWillGoNova_bool.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ systemEconomy_number

- (NSNumber *) systemEconomy_number

Extends class PlayerEntity.

Definition at line 1127 of file PlayerEntityLegacyScriptEngine.m.

{
    NSDictionary *systeminfo = [UNIVERSE currentSystemData];
    return [systeminfo objectForKey:KEY_ECONOMY];
}

References systemEconomy_number.

Referenced by systemEconomy_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ systemEconomy_string

- (NSString *) systemEconomy_string

Extends class PlayerEntity.

Definition at line 1117 of file PlayerEntityLegacyScriptEngine.m.

{
    int economy = [[self systemEconomy_number] intValue]; // 0 .. 7 (0 rich industrial .. 7 poor agricultural)
    NSString *result = OODisplayStringFromEconomyID(economy);
    if (result == nil) result = @"UNKNOWN";
    
    return result;
}

References nil, OODisplayStringFromEconomyID(), PlayerEntity::systemEconomy_number, and systemEconomy_string.

Referenced by systemEconomy_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ systemGovernment_number

- (NSNumber *) systemGovernment_number

Extends class PlayerEntity.

Definition at line 1110 of file PlayerEntityLegacyScriptEngine.m.

{
    NSDictionary *systeminfo = [UNIVERSE currentSystemData];
    return [systeminfo objectForKey:KEY_GOVERNMENT];
}

References systemGovernment_number.

Referenced by systemGovernment_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ systemGovernment_string

- (NSString *) systemGovernment_string

Extends class PlayerEntity.

Definition at line 1100 of file PlayerEntityLegacyScriptEngine.m.

{
    int government = [[self systemGovernment_number] intValue]; // 0 .. 7 (0 anarchic .. 7 most stable)
    NSString *result = OODisplayStringFromGovernmentID(government);
    if (result == nil) result = @"UNKNOWN";
    
    return result;
}

References nil, OODisplayStringFromGovernmentID(), PlayerEntity::systemGovernment_number, and systemGovernment_string.

Referenced by systemGovernment_string.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ systemPopulation_number

- (NSNumber *) systemPopulation_number

Extends class PlayerEntity.

Definition at line 1141 of file PlayerEntityLegacyScriptEngine.m.

{
    NSDictionary *systeminfo = [UNIVERSE currentSystemData];
    return [systeminfo objectForKey:KEY_POPULATION];
}

References systemPopulation_number.

Referenced by systemPopulation_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ systemProductivity_number

- (NSNumber *) systemProductivity_number

Extends class PlayerEntity.

Definition at line 1148 of file PlayerEntityLegacyScriptEngine.m.

{
    NSDictionary *systeminfo = [UNIVERSE currentSystemData];
    return [systeminfo objectForKey:KEY_PRODUCTIVITY];
}

References systemProductivity_number.

Referenced by systemProductivity_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ systemTechLevel_number

- (NSNumber *) systemTechLevel_number

Extends class PlayerEntity.

Definition at line 1134 of file PlayerEntityLegacyScriptEngine.m.

{
    NSDictionary *systeminfo = [UNIVERSE currentSystemData];
    return [systeminfo objectForKey:KEY_TECHLEVEL];
}

References systemTechLevel_number.

Referenced by systemTechLevel_number.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ targetNearestHostile

- (void) targetNearestHostile

Extends class PlayerEntity.

Definition at line 2928 of file PlayerEntityLegacyScriptEngine.m.

{
    [self scanForHostiles];
    Entity *ent = [self foundTarget];
    if (ent != nil)
    {
        ident_engaged = YES;
        missile_status = MISSILE_STATUS_TARGET_LOCKED;
        [self addTarget:ent];
    }
}

References PlayerEntity::addTarget:, ShipEntity::foundTarget, MISSILE_STATUS_TARGET_LOCKED, nil, ShipEntity::scanForHostiles, and targetNearestHostile.

Referenced by targetNearestHostile.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ targetNearestIncomingMissile

- (void) targetNearestIncomingMissile

Extends class PlayerEntity.

Definition at line 2941 of file PlayerEntityLegacyScriptEngine.m.

{
    [self scanForNearestIncomingMissile];
    Entity *ent = [self foundTarget];
    if (ent != nil)
    {
        ident_engaged = YES;
        missile_status = MISSILE_STATUS_TARGET_LOCKED;
        [self addTarget:ent];
    }
}

References PlayerEntity::addTarget:, ShipEntity::foundTarget, MISSILE_STATUS_TARGET_LOCKED, nil, ShipEntity::scanForNearestIncomingMissile, and targetNearestIncomingMissile.

Referenced by targetNearestIncomingMissile.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ testForEquipment:

- (void) testForEquipment: (NSString *) equipString

Extends class PlayerEntity.

Definition at line 1445 of file PlayerEntityLegacyScriptEngine.m.

                         :(NSString *)equipString   //eg. EQ_NAVAL_ENERGY_UNIT
{
    found_equipment = [self hasEquipmentItem:equipString];
}

References ShipEntity::hasEquipmentItem:.

Here is the call graph for this function:

◆ TestScriptConditions

+ (static BOOL) TestScriptConditions (NSArray *) conditions

implementation

Extends class PlayerEntity.

Definition at line 233 of file PlayerEntityLegacyScriptEngine.m.

{
    NSEnumerator            *condEnum = nil;
    NSArray                 *condition = nil;
    PlayerEntity            *player = PLAYER;
    
    for (condEnum = [conditions objectEnumerator]; (condition = [condEnum nextObject]); )
    {
        if (![player scriptTestCondition:condition])  return NO;
    }
    
    return YES;
}

References nil, PLAYER, and TestScriptConditions.

Referenced by PerformConditionalStatment, processSceneDictionary:atOffset:, scriptTestConditions:, and TestScriptConditions.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ useSpecialCargo:

- (void) useSpecialCargo: (NSString *) descriptionString

Extends class PlayerEntity.

Definition at line 1435 of file PlayerEntityLegacyScriptEngine.m.

                        :(NSString *)descriptionString
{
    if (scriptTarget != self)  return;
 
    [self removeAllCargo:YES];  
    OOLog(kOOLogNoteUseSpecialCargo, @"Going to useSpecialCargo:'%@'", descriptionString);
    specialCargo = [OOExpand(descriptionString) retain];
}

References kOOLogNoteUseSpecialCargo, OOLog, PlayerEntity::removeAllCargo:, and scriptTarget.

Here is the call graph for this function:

◆ worldScriptsRequiringTickle

- (NSDictionary *) worldScriptsRequiringTickle

implementation

Extends class PlayerEntity.

Definition at line 282 of file PlayerEntityLegacyScriptEngine.m.

{
    if (worldScriptsRequiringTickle != nil)  return worldScriptsRequiringTickle;
    
    NSMutableDictionary *tickleScripts = [NSMutableDictionary dictionaryWithCapacity:[worldScripts count]];
    NSString *scriptName;
    foreachkey (scriptName, worldScripts)
    {
        OOScript *candidateScript = [worldScripts objectForKey:scriptName];
        if ([candidateScript requiresTickle])
        {
            [tickleScripts setObject:candidateScript forKey:scriptName];
        }
    }
    
    worldScriptsRequiringTickle = [tickleScripts copy];
    return worldScriptsRequiringTickle;
}

References foreachkey, nil, and worldScriptsRequiringTickle.

Referenced by checkScript, PlayerEntity::dealloc, PlayerEntity::setUpAndConfirmOK:saveGame:, and worldScriptsRequiringTickle.

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/Core/Entities/PlayerEntityLegacyScriptEngine.h
src/Core/Entities/PlayerEntityLegacyScriptEngine.m

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ add:

◆ addEqScriptForKey:

◆ addLiteralMissionText:

◆ addMissionDestination:

◆ addMissionText:

◆ addMoon:

◆ addPlanet:

◆ addScene:atOffset:

◆ addShips:

◆ addShipsAt:

◆ addShipsAtPrecisely:

◆ addShipsWithinRadius:

◆ addSystemShips:

◆ awardCargo:

◆ awardCredits:

◆ awardEquipment:

◆ awardFuel:

◆ awardShipKills:

◆ blowUpStation

◆ checkForShips:

◆ checkScript

◆ clearMissionDescription

◆ clearMissionDescriptionForMission:

◆ clearMissionScreen

◆ clearMissionScreenID

◆ clock_days_number

◆ clock_hours_number

◆ clock_mins_number

◆ clock_number

◆ clock_secs_number

◆ commanderLegalStatus_number

◆ commanderLegalStatus_string

◆ commanderName_string

◆ commanderRank_string

◆ commanderShip_string

◆ commanderShipDisplayName_string

◆ commsMessage:

◆ commsMessageByUnpiloted:

◆ consoleMessage3s:

◆ consoleMessage6s:

◆ credits_number

◆ CurrentScriptDesc(void)

◆ CurrentScriptNameOr

◆ d100_number

◆ d256_number

◆ debugMessage:

◆ debugOff

◆ debugOn

◆ decrement:

◆ dockedAtMainStation_bool

◆ dockedStationName_string

◆ dockedTechLevel_number

◆ doMissionCallback

◆ ejectItem:

◆ endMissionScreenAndNoteOpportunity

◆ eqScriptIndexForKey:

◆ expandMessage:

◆ expandScriptRightHandSide:

◆ foundEquipment_bool

◆ fuelLeakRate_number

◆ fuelLevel_number

◆ galaxy_number

◆ gui_screen_string

◆ increment:

◆ launchFromStation

◆ localVariableForKey:andMission:

◆ localVariablesForMission:

◆ messageShipAIs:

◆ mission_string

◆ missionChoice_string

◆ missionKeyPress_string

◆ missionScreenID

◆ missionsList

◆ missionTitle

◆ missionVariableForKey:

◆ missionVariables