PlayerEntity(ScriptMethods) Category Reference

#include <PlayerEntityScriptMethods.h>

Instance Methods
(unsigned)	- score
(void)	- setScore:
(double)	- creditBalance
(void)	- setCreditBalance:
(NSString *)	- dockedStationName
(NSString *)	- dockedStationDisplayName
(BOOL)	- dockedAtMainStation
(void)	- awardCommodityType:amount:
(void)	- resetScannerZoom
(OOGalaxyID)	- currentGalaxyID
(OOSystemID)	- currentSystemID
(void)	- setMissionChoice:
(void)	- setMissionChoice:withEvent:
(void)	- setMissionChoice:keyPress:
(void)	- setMissionChoice:keyPress:withEvent:
(void)	- allowMissionInterrupt
(OOTimeDelta)	- scriptTimer
(unsigned)	- systemPseudoRandom100
(unsigned)	- systemPseudoRandom256
(double)	- systemPseudoRandomFloat
(NSDictionary *)	- passengerContractMarker:
(NSDictionary *)	- parcelContractMarker:
(NSDictionary *)	- cargoContractMarker:
(NSDictionary *)	- defaultMarker:
(NSDictionary *)	- validatedMarker:
(NSString *)	- keyBindingDescription2:
(NSString *)	- getKeyBindingDescription:
(NSString *)	- keyCodeDescription:
(NSString *)	- keyCodeDescriptionShort:
(NSString *)	- commanderKillsAsString
(NSString *)	- commanderBountyAsString
(NSString *)	- creditsFormattedForSubstitution
(NSString *)	- creditsFormattedForLegacySubstitution

Detailed Description

Definition at line 31 of file PlayerEntityScriptMethods.h.

Method Documentation

allowMissionInterrupt

- (void) allowMissionInterrupt

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    _missionAllowInterrupt = YES;
}

awardCommodityType:amount:

- (void) awardCommodityType:		(NSString *)	type
amount:		(OOCargoQuantity)	amount

Definition at line 623 of file PlayerEntityScriptMethods.m.

                           :(OOCommodityType)type amount:(OOCargoQuantity)amount
{
    OOMassUnit              unit;
 
    if (![[UNIVERSE commodities] goodDefined:type])
    {
        return;
    }
    
    OOLog(@"script.debug.note.awardCargo", @"Going to award cargo: %d x '%@'", amount, type);
    
    unit = [shipCommodityData massUnitForGood:type];
    
    if ([self status] != STATUS_DOCKED)
    {
        // in-flight
        while (amount)
        {
            if (unit != UNITS_TONS)
            {
                if (specialCargo)
                {
                    // is this correct behaviour?
                    [shipCommodityData addQuantity:amount forGood:type];
                }
                else
                {
                    int amount_per_container = (unit == UNITS_KILOGRAMS)? 1000 : 1000000;
                    while (amount > 0)
                    {
                        int smaller_quantity = 1 + ((amount - 1) % amount_per_container);
                        if ([cargo count] < [self maxAvailableCargoSpace])
                        {
                            ShipEntity* container = [UNIVERSE newShipWithRole:@"1t-cargopod"];
                            if (container)
                            {
                                // the cargopod ship is just being set up. If ejected,  will call UNIVERSE addEntity
                                // [container wasAddedToUniverse]; // seems to be not needed anymore for pods
                                [container setScanClass: CLASS_CARGO];
                                [container setStatus:STATUS_IN_HOLD];
                                [container setCommodity:type andAmount:smaller_quantity];
                                [cargo addObject:container];
                                [container release];
                            }
                        }
                        amount -= smaller_quantity;
                    }
                }
            }
            else if (!specialCargo)
            // no adding TCs while special cargo in hold
            {
                // put each ton in a separate container
                while (amount)
                {
                    if ([cargo count] < [self maxAvailableCargoSpace])
                    {
                        ShipEntity* container = [UNIVERSE newShipWithRole:@"1t-cargopod"];
                        if (container)
                        {
                            // the cargopod ship is just being set up. If ejected, will call UNIVERSE addEntity
                            // [container wasAddedToUniverse]; // seems to be not needed anymore for pods
                            [container setScanClass: CLASS_CARGO];
                            [container setStatus:STATUS_IN_HOLD];
                            [container setCommodity:type andAmount:1];
                            [cargo addObject:container];
                            [container release];
                        }
                    }
                    amount--;
                }
            }
        }
    }
    else
    {   // docked
        // like purchasing a commodity
        int manifest_quantity = [shipCommodityData quantityForGood:type];
        while ((amount)&&(current_cargo < [self maxAvailableCargoSpace]))
        {
            manifest_quantity++;
            amount--;
            if (unit == UNITS_TONS)  current_cargo++;
        }
        [shipCommodityData setQuantity:manifest_quantity forGood:type];
    }
    [self calculateCurrentCargo];
}

cargoContractMarker:

- (NSDictionary *) cargoContractMarker:

(OOSystemID)

system

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                      :(OOSystemID)system
{
    return [[[NSDictionary dictionaryWithObjectsAndKeys:
                                [NSNumber numberWithInt:system], @"system",
                                MISSION_DEST_LEGACY, @"name",
                                @"orangeColor", @"markerColor",
                                @"MARKER_SQUARE", @"markerShape",
                                nil] retain] autorelease];
}

commanderBountyAsString

- (NSString *) commanderBountyAsString

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return [NSString stringWithFormat:@"%i", [self legalStatus]];
}

commanderKillsAsString

- (NSString *) commanderKillsAsString

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return [NSString stringWithFormat:@"%i", [self score]];
}

creditBalance

- (double) creditBalance

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return 0.1 * credits;
}

creditsFormattedForLegacySubstitution

- (NSString *) creditsFormattedForLegacySubstitution

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    OOCreditsQuantity   tenthsOfCredits = [self deciCredits];
    unsigned long long  integerCredits = tenthsOfCredits / 10;
    unsigned long long  tenths = tenthsOfCredits % 10;
    
    return [NSString stringWithFormat:@"%llu.%llu", integerCredits, tenths];
}

creditsFormattedForSubstitution

- (NSString *) creditsFormattedForSubstitution

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return OOStringFromDeciCredits([self deciCredits], YES, NO);
}

currentGalaxyID

- (OOGalaxyID) currentGalaxyID

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return galaxy_number;
}

currentSystemID

- (OOSystemID) currentSystemID

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    if ([UNIVERSE sun] == nil)  return -1;  // Interstellar space
    return [UNIVERSE currentSystemID];
}

defaultMarker:

- (NSDictionary *) defaultMarker:

(OOSystemID)

system

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                :(OOSystemID)system
{
    return [[[NSDictionary dictionaryWithObjectsAndKeys:
                                [NSNumber numberWithInt:system], @"system",
                                MISSION_DEST_LEGACY, @"name",
                                @"redColor", @"markerColor",
                                @"MARKER_X", @"markerShape",
                                nil] retain] autorelease];
}

dockedAtMainStation

- (BOOL) dockedAtMainStation

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return [self status] == STATUS_DOCKED && [self dockedStation] == [UNIVERSE station];
}

dockedStationDisplayName

- (NSString *) dockedStationDisplayName

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return [[self dockedStation] displayName];
}

dockedStationName

- (NSString *) dockedStationName

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return [[self dockedStation] name];
}

getKeyBindingDescription:

- (NSString *) getKeyBindingDescription:

(NSArray *)

keyList

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                       :(NSArray *) keyList
{
    NSUInteger i = 0;
    NSMutableString *final = [NSMutableString string];
    for (i = 0; i < [keyList count]; i++) {
        if (i != 0) final = [NSMutableString stringWithFormat:@"%@ or ", final];
        NSDictionary *def = [keyList objectAtIndex:i];
        NSString *key = [def objectForKey:@"key"];
        OOKeyCode k_int = (OOKeyCode)[key integerValue];
        NSString *desc = [self keyCodeDescription:k_int];
        // 0 = key not set
        if (k_int != 0) {
            if ([[def objectForKey:@"mod2"] boolValue] == YES) final = [NSMutableString stringWithFormat:@"%@%@+", final, keyMod2Text];
            if ([[def objectForKey:@"mod1"] boolValue] == YES) final = [NSMutableString stringWithFormat:@"%@%@+", final, keyMod1Text];
            if ([[def objectForKey:@"shift"] boolValue] == YES) final = [NSMutableString stringWithFormat:@"%@%@+", final, keyShiftText];
            final = [NSMutableString stringWithFormat:@"%@%@", final, desc];
        }
    }
    return final;
}

keyBindingDescription2:

- (NSString *) keyBindingDescription2:

(NSString *)

binding

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                     :(NSString *)binding
{
    if ([keyconfig2_settings objectForKey:binding] == nil)
    {
        // no such setting
        return nil;
    }
    NSArray *keyList = (NSArray*)[keyconfig2_settings objectForKey:binding];
    return [self getKeyBindingDescription:keyList];
}

keyCodeDescription:

- (NSString *) keyCodeDescription:

(OOKeyCode)

code

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                 :(OOKeyCode)code
{
    switch (code)
    {
    case 0:
        return DESC(@"oolite-keycode-unset");
    case 9:
        return DESC(@"oolite-keycode-tab");
    case 13:
        return DESC(@"oolite-keycode-enter");
    case 27:
        return DESC(@"oolite-keycode-esc");
    case 32:
        return DESC(@"oolite-keycode-space");
    case gvFunctionKey1:
        return DESC(@"oolite-keycode-f1");
    case gvFunctionKey2:
        return DESC(@"oolite-keycode-f2");
    case gvFunctionKey3:
        return DESC(@"oolite-keycode-f3");
    case gvFunctionKey4:
        return DESC(@"oolite-keycode-f4");
    case gvFunctionKey5:
        return DESC(@"oolite-keycode-f5");
    case gvFunctionKey6:
        return DESC(@"oolite-keycode-f6");
    case gvFunctionKey7:
        return DESC(@"oolite-keycode-f7");
    case gvFunctionKey8:
        return DESC(@"oolite-keycode-f8");
    case gvFunctionKey9:
        return DESC(@"oolite-keycode-f9");
    case gvFunctionKey10:
        return DESC(@"oolite-keycode-f10");
    case gvFunctionKey11:
        return DESC(@"oolite-keycode-f11");
    case gvArrowKeyRight:
        return DESC(@"oolite-keycode-right");
    case gvArrowKeyLeft:
        return DESC(@"oolite-keycode-left");
    case gvArrowKeyDown:
        return DESC(@"oolite-keycode-down");
    case gvArrowKeyUp:
        return DESC(@"oolite-keycode-up");
    case gvHomeKey:
        return DESC(@"oolite-keycode-home");
    case gvEndKey:
        return DESC(@"oolite-keycode-end");
    case gvInsertKey:
        return DESC(@"oolite-keycode-insert");
    case gvDeleteKey:
        return DESC(@"oolite-keycode-delete");
    case gvPageUpKey:
        return DESC(@"oolite-keycode-pageup");
    case gvPageDownKey:
        return DESC(@"oolite-keycode-pagedown");
    case gvNumberPadKey0:
        return DESC(@"oolite-keycode-numpad0");
    case gvNumberPadKey1:
        return DESC(@"oolite-keycode-numpad1");
    case gvNumberPadKey2:
        return DESC(@"oolite-keycode-numpad2");
    case gvNumberPadKey3:
        return DESC(@"oolite-keycode-numpad3");
    case gvNumberPadKey4:
        return DESC(@"oolite-keycode-numpad4");
    case gvNumberPadKey5:
        return DESC(@"oolite-keycode-numpad5");
    case gvNumberPadKey6:
        return DESC(@"oolite-keycode-numpad6");
    case gvNumberPadKey7:
        return DESC(@"oolite-keycode-numpad7");
    case gvNumberPadKey8:
        return DESC(@"oolite-keycode-numpad8");
    case gvNumberPadKey9:
        return DESC(@"oolite-keycode-numpad9");
    case gvPrintScreenKey:
        return DESC(@"oolite-keycode-printscreen");
    case gvPauseKey:
        return DESC(@"oolite-keycode-pause");
    case gvNumberPadKeyDivide:
        return DESC(@"oolite-keycode-numpad/");
    case gvNumberPadKeyEquals:
        return DESC(@"oolite-keycode-numpad=");
    case gvNumberPadKeyMinus:
        return DESC(@"oolite-keycode-numpad-");
    case gvNumberPadKeyMultiply:
        return DESC(@"oolite-keycode-numpad*");
    case gvNumberPadKeyPeriod:
        return DESC(@"oolite-keycode-numpad.");
    case gvNumberPadKeyPlus:
        return DESC(@"oolite-keycode-numpad+");
    case gvNumberPadKeyEnter:
        return DESC(@"oolite-keycode-numpadenter");
        
    default:
        return [NSString stringWithFormat:@"%C",code];
    }
}

keyCodeDescriptionShort:

- (NSString *) keyCodeDescriptionShort:

(OOKeyCode)

code

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                      :(OOKeyCode)code
{
    switch (code)
    {
    case 0:
        return DESC(@"oolite-keycode-short-unset");
    case 9:
        return DESC(@"oolite-keycode-short-tab");
    case 13:
        return DESC(@"oolite-keycode-short-enter");
    case 27:
        return DESC(@"oolite-keycode-short-esc");
    case 32:
        return DESC(@"oolite-keycode-short-space");
    case gvFunctionKey1:
        return DESC(@"oolite-keycode-short-f1");
    case gvFunctionKey2:
        return DESC(@"oolite-keycode-short-f2");
    case gvFunctionKey3:
        return DESC(@"oolite-keycode-short-f3");
    case gvFunctionKey4:
        return DESC(@"oolite-keycode-short-f4");
    case gvFunctionKey5:
        return DESC(@"oolite-keycode-short-f5");
    case gvFunctionKey6:
        return DESC(@"oolite-keycode-short-f6");
    case gvFunctionKey7:
        return DESC(@"oolite-keycode-short-f7");
    case gvFunctionKey8:
        return DESC(@"oolite-keycode-short-f8");
    case gvFunctionKey9:
        return DESC(@"oolite-keycode-short-f9");
    case gvFunctionKey10:
        return DESC(@"oolite-keycode-short-f10");
    case gvFunctionKey11:
        return DESC(@"oolite-keycode-short-f11");
    case gvArrowKeyRight:
        return DESC(@"oolite-keycode-short-right");
    case gvArrowKeyLeft:
        return DESC(@"oolite-keycode-short-left");
    case gvArrowKeyDown:
        return DESC(@"oolite-keycode-short-down");
    case gvArrowKeyUp:
        return DESC(@"oolite-keycode-short-up");
    case gvHomeKey:
        return DESC(@"oolite-keycode-short-home");
    case gvEndKey:
        return DESC(@"oolite-keycode-short-end");
    case gvInsertKey:
        return DESC(@"oolite-keycode-short-insert");
    case gvDeleteKey:
        return DESC(@"oolite-keycode-short-delete");
    case gvPageUpKey:
        return DESC(@"oolite-keycode-short-pageup");
    case gvPageDownKey:
        return DESC(@"oolite-keycode-short-pagedown");
    case gvNumberPadKey0:
        return DESC(@"oolite-keycode-short-numpad0");
    case gvNumberPadKey1:
        return DESC(@"oolite-keycode-short-numpad1");
    case gvNumberPadKey2:
        return DESC(@"oolite-keycode-short-numpad2");
    case gvNumberPadKey3:
        return DESC(@"oolite-keycode-short-numpad3");
    case gvNumberPadKey4:
        return DESC(@"oolite-keycode-short-numpad4");
    case gvNumberPadKey5:
        return DESC(@"oolite-keycode-short-numpad5");
    case gvNumberPadKey6:
        return DESC(@"oolite-keycode-short-numpad6");
    case gvNumberPadKey7:
        return DESC(@"oolite-keycode-short-numpad7");
    case gvNumberPadKey8:
        return DESC(@"oolite-keycode-short-numpad8");
    case gvNumberPadKey9:
        return DESC(@"oolite-keycode-short-numpad9");
    case gvPrintScreenKey:
        return DESC(@"oolite-keycode-short-printscreen");
    case gvPauseKey:
        return DESC(@"oolite-keycode-short-pause");
    case gvNumberPadKeyDivide:
        return DESC(@"oolite-keycode-short-numpad/");
    case gvNumberPadKeyEquals:
        return DESC(@"oolite-keycode-short-numpad=");
    case gvNumberPadKeyMinus:
        return DESC(@"oolite-keycode-short-numpad-");
    case gvNumberPadKeyMultiply:
        return DESC(@"oolite-keycode-short-numpad*");
    case gvNumberPadKeyPeriod:
        return DESC(@"oolite-keycode-short-numpad.");
    case gvNumberPadKeyPlus:
        return DESC(@"oolite-keycode-short-numpad+");
    case gvNumberPadKeyEnter:
        return DESC(@"oolite-keycode-short-numpadenter");
    default:
        return [NSString stringWithFormat:@"%C",code];
    }
}

parcelContractMarker:

- (NSDictionary *) parcelContractMarker:

(OOSystemID)

system

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                       :(OOSystemID)system
{
    return [[[NSDictionary dictionaryWithObjectsAndKeys:
                                [NSNumber numberWithInt:system], @"system",
                                MISSION_DEST_LEGACY, @"name",
                                @"orangeColor", @"markerColor",
                                @"MARKER_PLUS", @"markerShape",
                                nil] retain] autorelease];
}

passengerContractMarker:

- (NSDictionary *) passengerContractMarker:

(OOSystemID)

system

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                          :(OOSystemID)system
{
    return [[[NSDictionary dictionaryWithObjectsAndKeys:
                                [NSNumber numberWithInt:system], @"system",
                                MISSION_DEST_LEGACY, @"name",
                                @"orangeColor", @"markerColor",
                                @"MARKER_DIAMOND", @"markerShape",
                                nil] retain] autorelease];
}

resetScannerZoom

- (void) resetScannerZoom

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    scanner_zoom_rate = SCANNER_ZOOM_RATE_DOWN;
}

score

- (unsigned) score

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return ship_kills;
}

scriptTimer

- (OOTimeDelta) scriptTimer

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    return script_time;
}

setCreditBalance:

- (void) setCreditBalance:

(double)

value

Definition at line 623 of file PlayerEntityScriptMethods.m.

                         :(double)value
{
    credits = OODeciCreditsFromDouble(value * 10.0);
}

setMissionChoice:

- (void) setMissionChoice:

(NSString *)

newChoice

Definition at line 623 of file PlayerEntityScriptMethods.m.

                         :(NSString *)newChoice
{
    [self setMissionChoice:newChoice keyPress:@"" withEvent:YES];
}

setMissionChoice:keyPress:

- (void) setMissionChoice:		(NSString *)	newChoice
keyPress:		(NSString *)	keyPress

Definition at line 623 of file PlayerEntityScriptMethods.m.

                         :(NSString *)newChoice keyPress:(NSString *)keyPress
{
    [self setMissionChoice:newChoice keyPress:keyPress withEvent:YES];
}

setMissionChoice:keyPress:withEvent:

- (void) setMissionChoice:		(NSString *)	newChoice
keyPress:		(NSString *)	keyPress
withEvent:		(BOOL)	withEvent

Definition at line 623 of file PlayerEntityScriptMethods.m.

                         :(NSString *)newChoice keyPress:(NSString *)keyPress withEvent:(BOOL)withEvent
{
    BOOL equal = [newChoice isEqualToString:missionChoice] || (newChoice == missionChoice); // Catch both being nil as well
    if (!equal)
    {
        if (newChoice == nil)
        {
            NSString *oldChoice = missionChoice;
            [missionChoice autorelease];
            missionChoice = nil;
            if (withEvent) [self doScriptEvent:OOJSID("missionChoiceWasReset") withArgument:oldChoice];
        }
        else
        {
            [missionChoice autorelease];
            missionChoice = [newChoice copy];
        }
    }
    equal = [keyPress isEqualToString:missionKeyPress] || (keyPress == missionKeyPress);
    if (!equal) 
    {
        [missionKeyPress autorelease];
        missionKeyPress = [keyPress copy];
    }
}

setMissionChoice:withEvent:

- (void) setMissionChoice:		(NSString *)	newChoice
withEvent:		(BOOL)	withEvent

Definition at line 623 of file PlayerEntityScriptMethods.m.

                         :(NSString *)newChoice withEvent:(BOOL)withEvent
{
    [self setMissionChoice:newChoice keyPress:@"" withEvent:withEvent];
}

setScore:

- (void) setScore:

(unsigned)

value

Definition at line 623 of file PlayerEntityScriptMethods.m.

                 :(unsigned)value
{
    ship_kills = value;
}

systemPseudoRandom100

- (unsigned) systemPseudoRandom100

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    seed_RNG_only_for_planet_description([[UNIVERSE systemManager] getRandomSeedForCurrentSystem]);
    return (gen_rnd_number() * 256 + gen_rnd_number()) % 100;
}

systemPseudoRandom256

- (unsigned) systemPseudoRandom256

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    seed_RNG_only_for_planet_description([[UNIVERSE systemManager] getRandomSeedForCurrentSystem]);
    return gen_rnd_number();
}

systemPseudoRandomFloat

- (double) systemPseudoRandomFloat

Definition at line 623 of file PlayerEntityScriptMethods.m.

{
    seed_RNG_only_for_planet_description([[UNIVERSE systemManager] getRandomSeedForCurrentSystem]);
    unsigned a = gen_rnd_number();
    unsigned b = gen_rnd_number();
    unsigned c = gen_rnd_number();
    
    a = (a << 16) | (b << 8) | c;
    return (double)a / (double)0x01000000;
    
}

validatedMarker:

- (NSDictionary *) validatedMarker:

(NSDictionary *)

marker

Definition at line 623 of file PlayerEntityScriptMethods.m.

                                  :(NSDictionary *)marker
{
    OOSystemID dest = [marker oo_intForKey:@"system"];
// FIXME: parameters
    if (dest < 0 || dest > kOOMaximumSystemID)
    {
        return nil;
    }
    NSString *group = [marker oo_stringForKey:@"name" defaultValue:MISSION_DEST_LEGACY];
 
    return [[[NSDictionary dictionaryWithObjectsAndKeys:
                                [NSNumber numberWithInt:dest], @"system",
                                group, @"name",
                                [marker oo_stringForKey:@"markerColor" defaultValue:@"redColor"], @"markerColor",
                                [marker oo_stringForKey:@"markerShape" defaultValue:@"MARKER_X"], @"markerShape",
                              [NSNumber numberWithFloat:[marker oo_floatForKey:@"markerScale" defaultValue:1.0]], @"markerScale",
                                nil] retain] autorelease];
 
}

---

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

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