OOJSMission.m File Reference

import "OOJSMission.h"
import "OOJavaScriptEngine.h"
import "OOJSScript.h"
import "OOConstToJSString.h"
import "OOJSVector.h"
import "OOJSPlayer.h"
import "PlayerEntityScriptMethods.h"
import "OOStringExpander.h"
import "OOCollectionExtractors.h"
import "OOMusicController.h"
import "GuiDisplayGen.h"
import "OODebugStandards.h"

Include dependency graph for OOJSMission.m:

Go to the source code of this file.

Enumerations
enum	{ kMission_markedSystems , kMission_screenID , kMission_exitScreen }

Functions
static JSBool	MissionGetProperty (JSContext *context, JSObject *this, jsid propID, jsval *value)
static JSBool	MissionSetProperty (JSContext *context, JSObject *this, jsid propID, JSBool strict, jsval *value)
static JSBool	MissionMarkSystem (JSContext *context, uintN argc, jsval *vp)
static JSBool	MissionUnmarkSystem (JSContext *context, uintN argc, jsval *vp)
static JSBool	MissionAddMessageText (JSContext *context, uintN argc, jsval *vp)
static JSBool	MissionSetInstructions (JSContext *context, uintN argc, jsval *vp)
static JSBool	MissionSetInstructionsKey (JSContext *context, uintN argc, jsval *vp)
static JSBool	MissionRunScreen (JSContext *context, uintN argc, jsval *vp)
static JSBool	MissionRunShipLibrary (JSContext *context, uintN argc, jsval *vp)
static JSBool	MissionSetInstructionsInternal (JSContext *context, uintN argc, jsval *vp, BOOL isKey)
void	InitOOJSMission (JSContext *context, JSObject *global)
void	MissionRunCallback ()
static NSDictionary *	GetParameterDictionary (JSContext *context, JSObject *object, const char *key)
static NSString *	GetParameterString (JSContext *context, JSObject *object, const char *key)
static NSDictionary *	GetParameterImageDescriptor (JSContext *context, JSObject *object, const char *key)

Variables
static jsval	sCallbackFunction
static jsval	sCallbackThis
static OOJSScript *	sCallbackScript = nil
static JSObject *	sMissionObject
static JSClass	sMissionClass
static JSPropertySpec	sMissionProperties []
static JSFunctionSpec	sMissionMethods []

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kMission_markedSystems
kMission_screenID
kMission_exitScreen

Definition at line 76 of file OOJSMission.m.

{
    kMission_markedSystems,
    kMission_screenID,
    kMission_exitScreen
};

Function Documentation

GetParameterDictionary()

static NSDictionary * GetParameterDictionary ( JSContext * context, JSObject * object, const char * key )

static

Definition at line 460 of file OOJSMission.m.

{
    jsval value = JSVAL_NULL;
    if (JS_GetProperty(context, object, key, &value))
    {
        if (JSVAL_IS_OBJECT(value))
        {
            return OOJSNativeObjectFromJSObject(context, JSVAL_TO_OBJECT(value));
        }
    }
    return nil;
}

References nil, and OOJSNativeObjectFromJSObject().

Referenced by MissionRunScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

GetParameterImageDescriptor()

static NSDictionary * GetParameterImageDescriptor ( JSContext * context, JSObject * object, const char * key )

static

Definition at line 485 of file OOJSMission.m.

{
    jsval value = JSVAL_NULL;
    if (JS_GetProperty(context, object, key, &value))
    {
        return [[UNIVERSE gui] textureDescriptorFromJSValue:value inContext:context callerDescription:@"mission.runScreen()"];
    }
    else
    {
        return nil;
    }
}

References nil.

GetParameterString()

static NSString * GetParameterString ( JSContext * context, JSObject * object, const char * key )

static

Definition at line 474 of file OOJSMission.m.

{
    jsval value = JSVAL_NULL;
    if (JS_GetProperty(context, object, key, &value))
    {
        return OOStringFromJSValue(context, value);
    }
    return nil;
}

References nil, and OOStringFromJSValue().

Referenced by MissionRunScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

InitOOJSMission()

void InitOOJSMission	(	JSContext *	context,
		JSObject *	global )

Definition at line 108 of file OOJSMission.m.

{
    sCallbackFunction = JSVAL_NULL;
    sCallbackThis = JSVAL_NULL;
    
    JSObject *missionPrototype = JS_InitClass(context, global, NULL, &sMissionClass, OOJSUnconstructableConstruct, 0, sMissionProperties, sMissionMethods, NULL, NULL);
    sMissionObject = JS_DefineObject(context, global, "mission", &sMissionClass, missionPrototype, OOJS_PROP_READONLY);
    
    // Ensure JS objects are rooted.
    OOJSAddGCValueRoot(context, &sCallbackFunction, "Pending mission callback function");
    OOJSAddGCValueRoot(context, &sCallbackThis, "Pending mission callback this");
}

References OOJS_PROP_READONLY, OOJSAddGCValueRoot, OOJSUnconstructableConstruct(), sCallbackFunction, sCallbackThis, sMissionClass, sMissionMethods, sMissionObject, and sMissionProperties.

Here is the call graph for this function:

MissionAddMessageText()

static JSBool MissionAddMessageText ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 361 of file OOJSMission.m.

{
    OOJS_NATIVE_ENTER(context)
    
    PlayerEntity        *player = OOPlayerForScripting();
    NSString            *text = nil;
    
    if (EXPECT_NOT(argc == 0))
    {
        OOJS_RETURN_VOID;
    }
    
    // Found "FIXME: warning if no mission screen running.",,,
    // However: used routinely by the Constrictor mission in F7, without mission screens.
    text = OOStringFromJSValue(context, OOJS_ARGV[0]);
    [player addLiteralMissionText:text];
    
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

References PlayerEntity::addLiteralMissionText:, EXPECT_NOT, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_VOID, OOPlayerForScripting(), and OOStringFromJSValue().

Here is the call graph for this function:

MissionGetProperty()

static JSBool MissionGetProperty ( JSContext * context, JSObject * this, jsid propID, jsval * value )

static

Definition at line 187 of file OOJSMission.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
 
    id result = nil;
    PlayerEntity        *player = OOPlayerForScripting();
 
    switch (JSID_TO_INT(propID))
    {
        case kMission_markedSystems:
            result = [player getMissionDestinations];
            if (result == nil)  result = [NSDictionary dictionary];
            result = [result allValues];
            break;
 
        case kMission_screenID:
            result = [player missionScreenID];
            break;
 
        case kMission_exitScreen:
            *value = OOJSValueFromGUIScreenID(context, [player missionExitScreen]);
            return YES;
 
        default:
            OOJSReportBadPropertySelector(context, this, propID, sMissionProperties);
            return NO;
    }
 
    *value = OOJSValueFromNativeObject(context, result);
    return YES;
    
    OOJS_NATIVE_EXIT
}

References PlayerEntity::getMissionDestinations, kMission_exitScreen, kMission_markedSystems, kMission_screenID, PlayerEntity::missionScreenID, nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOJSValueFromGUIScreenID(), OOJSValueFromNativeObject(), OOPlayerForScripting(), and sMissionProperties.

Here is the call graph for this function:

MissionMarkSystem()

static JSBool MissionMarkSystem ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 255 of file OOJSMission.m.

{
    OOJS_NATIVE_ENTER(context)
    
    PlayerEntity        *player = OOPlayerForScripting();
    unsigned i;
    int dest;
 
    // two pass. Once to validate, once to apply if they validate
    for (i=0;i<argc;i++)
    {
        if (!JS_ValueToInt32(context, OOJS_ARGV[i], &dest)) 
        {
            JS_ClearPendingException(context); // or JS_ValueToInt32 exception crashes JS engine
            if (!JSVAL_IS_OBJECT(OOJS_ARGV[i]))
            {
                OOJSReportBadArguments(context, @"Mission", @"markSystem", MIN(argc, 1U), OOJS_ARGV, nil, @"numbers or objects");
                return NO;
            }
        }
    }
 
    for (i=0;i<argc;i++)
    {
        if (JS_ValueToInt32(context, OOJS_ARGV[i], &dest)) 
        {
            OOStandardsDeprecated(@"Use of numbers for mission.markSystem is deprecated");
            if (!OOEnforceStandards())
            {
                [player addMissionDestinationMarker:[player defaultMarker:dest]];
            }
        }
        else // must be object, from above
        {
            JS_ClearPendingException(context); // or JS_ValueToInt32 exception crashes JS engine
            NSDictionary *marker = OOJSNativeObjectFromJSObject(context, JSVAL_TO_OBJECT(OOJS_ARGV[i]));
            OOSystemID system = [marker oo_intForKey:@"system" defaultValue:-1];
            if (system >= 0)
            {
                [player addMissionDestinationMarker:marker];
            }
        }
    }
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

References PlayerEntity::addMissionDestinationMarker:, PlayerEntity::defaultMarker:, MIN, nil, OOEnforceStandards(), OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_VOID, OOJSNativeObjectFromJSObject(), OOJSReportBadArguments(), OOPlayerForScripting(), and OOStandardsDeprecated().

Here is the call graph for this function:

MissionRunCallback()

void MissionRunCallback

(

void

)

Definition at line 122 of file OOJSMission.m.

{
    // don't do anything if we don't have a function.
    if (JSVAL_IS_NULL(sCallbackFunction) || JSVAL_IS_VOID(sCallbackFunction))  return;
    
    jsval               argval = JSVAL_VOID;
    jsval               argval2 = JSVAL_VOID;
    jsval               rval = JSVAL_VOID;
    PlayerEntity        *player = OOPlayerForScripting();
    OOJavaScriptEngine  *engine  = [OOJavaScriptEngine sharedEngine];
    JSContext           *context = OOJSAcquireContext();
    
    /*  Create temporarily-rooted local copies of sCallbackFunction and
        sCallbackThis, then clear the statics. This must be done in advance
        since the callback might call runScreen() and clobber the statics.
    */
    jsval               cbFunction = JSVAL_VOID;
    JSObject            *cbThis = NULL;
    OOJSScript          *cbScript = sCallbackScript;
    
    OOJSAddGCValueRoot(context, &cbFunction, "Mission callback function");
    OOJSAddGCObjectRoot(context, &cbThis, "Mission callback this");
    cbFunction = sCallbackFunction;
    cbScript = sCallbackScript;
    JS_ValueToObject(context, sCallbackThis, &cbThis);
    
    sCallbackScript = nil;
    sCallbackFunction = JSVAL_NULL;
    sCallbackThis = JSVAL_NULL;
    
    jsval args[2];
    argval = OOJSValueFromNativeObject(context, [player missionChoice_string]);
    argval2 = OOJSValueFromNativeObject(context, [player missionKeyPress_string]);
    args[0] = argval;
    args[1] = argval2;
 
    // now reset the mission choice silently, before calling the callback script.
    [player setMissionChoice:nil keyPress:@"" withEvent:NO];
    
    // Call the callback.
    @try
    {
        [OOJSScript pushScript:cbScript];
        [engine callJSFunction:cbFunction
                     forObject:cbThis
                          argc:2
                          argv:args
                        result:&rval];
    }
    @catch (NSException *exception)
    {
        // Squash any exception, allow cleanup to happen and so forth.
        OOLog(kOOLogException, @"Ignoring exception %@:%@ during handling of mission screen completion callback.", [exception name], [exception reason]);
    }
    [OOJSScript popScript:cbScript];
    
    // Manage that memory.
    [cbScript release];
    JS_RemoveValueRoot(context, &cbFunction);
    JS_RemoveObjectRoot(context, &cbThis);
    
    OOJSRelinquishContext(context);
}

References OOJavaScriptEngine::callJSFunction:forObject:argc:argv:result:, kOOLogException, nil, OOJSAcquireContext(), OOJSAddGCObjectRoot, OOJSAddGCValueRoot, OOJSRelinquishContext(), OOJSValueFromNativeObject(), OOLog, OOPlayerForScripting(), OOJSScript::popScript:, OOJSScript::pushScript:, sCallbackFunction, sCallbackScript, sCallbackThis, PlayerEntity::setMissionChoice:keyPress:withEvent:, and OOJavaScriptEngine::sharedEngine.

Here is the call graph for this function:

MissionRunScreen()

static JSBool MissionRunScreen ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 500 of file OOJSMission.m.

{
    OOJS_NATIVE_ENTER(context)
    
    PlayerEntity        *player = OOPlayerForScripting();
    jsval               function = JSVAL_NULL;
    jsval               value = JSVAL_NULL;
    JSObject            *params = NULL;
    
    // No mission screens during intro.
    if ([player status] == STATUS_START_GAME)
    {
        // (though no JS should be loaded at this stage, so this
        // check may be obsolete - CIM)
        OOJS_RETURN_BOOL(NO);
    }
    
    // Validate arguments.
    if (argc < 1 || !JS_ValueToObject(context, OOJS_ARGV[0], &params))
    {
        OOJSReportBadArguments(context, @"mission", @"runScreen", MIN(argc, 1U), &OOJS_ARGV[0], nil, @"parameter object");
        return NO;
    }
    
    if (argc > 1)  function = OOJS_ARGV[1];
    if (!JSVAL_IS_NULL(function) && !OOJSValueIsFunction(context, function))
    {
        OOJSReportBadArguments(context, @"mission", @"runScreen", 1, &OOJS_ARGV[1], nil, @"function");
        return NO;
    }
    
    // Not OOJS_BEGIN_FULL_NATIVE() - we use JSAPI while paused.
    OOJSPauseTimeLimiter();
    
    if (!JSVAL_IS_NULL(function))
    {
 
        /* CIM 30/12/12: This following line causes problems in certain
         * cases, but has to be kept for backward
         * compatibility. Documenting the third argument of
         * mission.runScreen will at least help people get around it in
         * multi-world-script mission screens. (Though, since no-one has
         * complained yet, perhaps I'm the only one who uses them?) */
 
        sCallbackScript = [[[OOJSScript currentlyRunningScript] weakRefUnderlyingObject] retain];
        if (argc > 2)
        {
            sCallbackThis = OOJS_ARGV[2];
        }
        else
        {
            sCallbackThis = OOJSValueFromNativeObject(context, sCallbackScript);
        }
    }
    
    // Apply settings.
    if (JS_GetProperty(context, params, "title", &value) && !JSVAL_IS_VOID(value))
    {
        [player setMissionTitle:OOStringFromJSValue(context, value)];
    }
    else
    {
        NSString *titleKey = GetParameterString(context, params, "titleKey");
        if (titleKey != nil)
        {
            NSString *message = [[UNIVERSE missiontext] oo_stringForKey:titleKey];
            if (message != nil)
            {
                [player setMissionTitle:OOExpand(message)];
            }
            else
            {
                OOJSReportWarning(context, @"Mission.runScreen: titleKey '%@' has no entry in missiontext.plist.", titleKey);
            }
        }
    }
    
    [[OOMusicController sharedController] setMissionMusic:GetParameterString(context, params, "music")];
    [player setMissionOverlayDescriptor:GetParameterImageDescriptor(context, params, "overlay")];
    [player setMissionBackgroundDescriptor:GetParameterImageDescriptor(context, params, "background")];
    [player setMissionBackgroundSpecial:GetParameterString(context, params, "backgroundSpecial")];
 
    if (JS_GetProperty(context, params, "customChartZoom", &value) && !JSVAL_IS_VOID(value))
    {
        jsdouble zoom;
        if (JS_ValueToNumber(context, value, &zoom))
        {
            if (zoom >= 1 && zoom <= CHART_MAX_ZOOM)
            {
                [player setCustomChartZoom:zoom];
            }
            else 
            {
                OOJSReportWarning(context, @"Mission.runScreen: invalid customChartZoom value specified.");
                [player setCustomChartZoom:1];
            }
        }
    }
    if (JS_GetProperty(context, params, "customChartCentre", &value) && !JSVAL_IS_VOID(value))
    {
        Vector vValue;
        if (JSValueToVector(context, value, &vValue))
        {
            NSPoint coords = { vValue.x, vValue.y };
            [player setCustomChartCentre:coords];
        }
        else 
        {
            [player setCustomChartCentre:[player galaxy_coordinates]];
            OOJSReportWarning(context, @"Mission.runScreen: invalid value for customChartCentre. Must be valid vector. Defaulting to current location.");
        }
    }
    if (JS_GetProperty(context, params, "customChartCentreInLY", &value) && !JSVAL_IS_VOID(value))
    {
        Vector vValue;
        if (JSValueToVector(context, value, &vValue))
        {
            NSPoint coords = OOInternalCoordinatesFromGalactic(vValue);
            [player setCustomChartCentre:coords];
        }
        else 
        {
            [player setCustomChartCentre:[player galaxy_coordinates]];
            OOJSReportWarning(context, @"Mission.runScreen: invalid value for customChartCentreInLY. Must be valid vector. Defaulting to current location.");
        }
    }
 
    [UNIVERSE removeDemoShips]; // remove any demoship or miniature planet that may be remaining from previous screens
    
    ShipEntity *demoShip = nil;
    if (JS_GetProperty(context, params, "model", &value) && !JSVAL_IS_VOID(value))
    {
        if ([player status] == STATUS_IN_FLIGHT && JSVAL_IS_STRING(value))
        {
            OOJSReportWarning(context, @"Mission.runScreen: model cannot be displayed while in flight.");
        }
        else
        {
            NSString *role = OOStringFromJSValue(context, value);
            
            JSBool spinning = YES;
            if (JS_GetProperty(context, params, "spinModel", &value) && !JSVAL_IS_VOID(value))
            {
                JS_ValueToBoolean(context, value, &spinning);
            }
            
        //  [player showShipModel:OOStringFromJSValue(context, value)];
            demoShip = [UNIVERSE makeDemoShipWithRole:role spinning:spinning];
        }
    }
    if (demoShip != nil)
    {
        if (JS_GetProperty(context, params, "modelPersonality", &value) && !JSVAL_IS_VOID(value))
        {
            int personality = 0;
            JS_ValueToInt32(context,value,&personality);
            [demoShip setEntityPersonalityInt:personality];
        }
        jsval demoShipVal = [demoShip oo_jsValueInContext:context];
        JS_SetProperty(context, sMissionObject, "displayModel", &demoShipVal);
    }
    else
    {
        JS_DeleteProperty(context, sMissionObject, "displayModel");
    }
 
    JSBool allowInterrupt = NO;
    // force the allowInterrupt to be YES while in flight
    if ([player status] == STATUS_IN_FLIGHT) 
    {
        allowInterrupt = YES;
    } 
    else
    {
        if (JS_GetProperty(context, params, "allowInterrupt", &value) && !JSVAL_IS_VOID(value))
        {
            JS_ValueToBoolean(context, value, &allowInterrupt);
        }
    }
 
    if (JS_GetProperty(context, params, "exitScreen", &value) && !JSVAL_IS_VOID(value))
    {
        [player setMissionExitScreen:OOGUIScreenIDFromJSValue(context, value)];
    }
    else
    {
        [player setMissionExitScreen:GUI_SCREEN_STATUS];
    }
 
    if (JS_GetProperty(context, params, "screenID", &value) && !JSVAL_IS_VOID(value))
    {
        [player setMissionScreenID:OOStringFromJSValue(context, value)];
    }
    else
    {
        [player clearMissionScreenID];
    }
 
    [player clearExtraMissionKeys];
    if (JS_GetProperty(context, params, "registerKeys", &value) && !JSVAL_IS_VOID(value))
    {
        [player setExtraMissionKeys:GetParameterDictionary(context, params, "registerKeys")];
    }
 
    JSBool textEntry = NO;
    if (JS_GetProperty(context, params, "textEntry", &value) && !JSVAL_IS_VOID(value))
    {
        JS_ValueToBoolean(context, value, &textEntry);
    }
    if (textEntry)
    {
        [player setMissionChoiceByTextEntry:YES];
    }
    else
    {
        [player setMissionChoiceByTextEntry:NO];
    }
 
    // Start the mission screen.
    sCallbackFunction = function;
    [player setGuiToMissionScreenWithCallback:!JSVAL_IS_NULL(sCallbackFunction)];
 
    // Apply more settings. (These must be done after starting the screen for legacy reasons.)
    if (allowInterrupt)
    {
        [player allowMissionInterrupt];
    }
    NSString *message = GetParameterString(context, params, "message");
    if (message != nil)
    {
        [player addLiteralMissionText:message];
    }
    else
    {
        NSString *messageKey = GetParameterString(context, params, "messageKey");
        if (messageKey != nil)  [player addMissionText:messageKey];
    }
    
    if (!textEntry)
    {
        NSDictionary *choices = GetParameterDictionary(context, params, "choices");
        if (choices == nil)
        {
            [player setMissionChoices:GetParameterString(context, params, "choicesKey")];
        }
        else 
        {
            [player setMissionChoicesDictionary:choices];       
        }
    }
 
    NSString *firstKey = GetParameterString(context, params, "initialChoicesKey");
    if (firstKey != nil)
    {
        OOGUIRow row = [[UNIVERSE gui] rowForKey:firstKey];
        if (row != -1)
        {
            [[UNIVERSE gui] setSelectedRow:row];
        }
    }
    
    // now clean up!
    [player setMissionOverlayDescriptor:nil];
    [player setMissionBackgroundDescriptor:nil];
    [player setMissionTitle:nil];
    [player setMissionMusic:nil];
    
    OOJSResumeTimeLimiter();
    
    OOJS_RETURN_BOOL(YES);
    
    OOJS_NATIVE_EXIT
}

References PlayerEntity::addLiteralMissionText:, PlayerEntity::addMissionText:, PlayerEntity::allowMissionInterrupt, CHART_MAX_ZOOM, PlayerEntity::clearExtraMissionKeys, PlayerEntity::clearMissionScreenID, OOJSScript::currentlyRunningScript, PlayerEntity::galaxy_coordinates, GetParameterDictionary(), GetParameterString(), JSValueToVector(), MIN, nil, Entity::oo_jsValueInContext:, OOInternalCoordinatesFromGalactic(), OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_BOOL, OOJSPauseTimeLimiter(), OOJSReportBadArguments(), OOJSReportWarning(), OOJSResumeTimeLimiter(), OOJSValueFromNativeObject(), OOJSValueIsFunction(), OOPlayerForScripting(), OOStringFromJSValue(), sCallbackFunction, sCallbackScript, sCallbackThis, PlayerEntity::setCustomChartCentre:, PlayerEntity::setCustomChartZoom:, ShipEntity::setEntityPersonalityInt:, PlayerEntity::setExtraMissionKeys:, PlayerEntity::setGuiToMissionScreenWithCallback:, PlayerEntity::setMissionBackgroundDescriptor:, PlayerEntity::setMissionBackgroundSpecial:, PlayerEntity::setMissionChoiceByTextEntry:, PlayerEntity::setMissionChoices:, PlayerEntity::setMissionChoicesDictionary:, PlayerEntity::setMissionExitScreen:, OOMusicController::setMissionMusic:, PlayerEntity::setMissionMusic:, PlayerEntity::setMissionOverlayDescriptor:, PlayerEntity::setMissionScreenID:, PlayerEntity::setMissionTitle:, OOMusicController::sharedController, and sMissionObject.

Here is the call graph for this function:

MissionRunShipLibrary()

static JSBool MissionRunShipLibrary ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 775 of file OOJSMission.m.

{
    OOJS_NATIVE_ENTER(context)
    
    PlayerEntity    *player = OOPlayerForScripting();
    BOOL            OK = YES;
    if ([player status] != STATUS_DOCKED)
    {
        OOJSReportWarning(context, @"Mission.runShipLibrary: must be docked.");
        OK = NO;
    }
    else
    {
        [PLAYER setGuiToIntroFirstGo:NO];
    }
    
    OOJS_RETURN_BOOL(OK);
    
    OOJS_NATIVE_EXIT
}

References OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_BOOL, OOJSReportWarning(), and OOPlayerForScripting().

Here is the call graph for this function:

MissionSetInstructions()

static JSBool MissionSetInstructions ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 392 of file OOJSMission.m.

{
    return MissionSetInstructionsInternal(context, argc, vp, NO);
}

References MissionSetInstructionsInternal().

Here is the call graph for this function:

MissionSetInstructionsInternal()

static JSBool MissionSetInstructionsInternal ( JSContext * context, uintN argc, jsval * vp, BOOL isKey )

static

Definition at line 398 of file OOJSMission.m.

{
    OOJS_NATIVE_ENTER(context)
    
    PlayerEntity        *player = OOPlayerForScripting();
    NSString            *text = nil;
    NSArray             *texts = nil;
    NSString            *missionKey = nil;
    
    if (EXPECT_NOT(argc == 0))
    {
        OOJSReportWarning(context, @"Usage error: mission.%@() called with no arguments. Treating as Mission.%@(null). This call may fail in a future version of Oolite.", isKey ? @"setInstructionsKey" : @"setInstructions", isKey ? @"setInstructionsKey" : @"setInstructions");
    }
    else if (EXPECT_NOT(JSVAL_IS_VOID(OOJS_ARGV[0])))
    {
        OOJSReportBadArguments(context, @"Mission", isKey ? @"setInstructionsKey" : @"setInstructions", 1, OOJS_ARGV, NULL, @"string or null");
        return NO;
    }
    else if (!JSVAL_IS_NULL(OOJS_ARGV[0]) && JSVAL_IS_OBJECT(OOJS_ARGV[0]))
    {
        texts = OOJSNativeObjectFromJSValue(context, OOJS_ARGV[0]);
    }
    else
    {
        text = OOStringFromJSValue(context, OOJS_ARGV[0]);
    }
    
    if (argc > 1)
    {
        missionKey = OOStringFromJSValueEvenIfNull(context, OOJS_ARGV[1]);
    }
    else
    {
        missionKey = [[OOJSScript currentlyRunningScript] name];
    }
    
    if (text != nil)
    {
        if (isKey)
        {
            [player setMissionDescription:text forMission:missionKey];
        }
        else
        {
            [player setMissionInstructions:text forMission:missionKey];
        }
    }
    else if (texts != nil && !isKey)
    {
        [player setMissionInstructionsList:texts forMission:missionKey];
    }
    else
    {
        [player clearMissionDescriptionForMission:missionKey];
    }
    
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

References PlayerEntity::clearMissionDescriptionForMission:, OOJSScript::currentlyRunningScript, EXPECT_NOT, OOJSScript::name, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_VOID, OOJSNativeObjectFromJSValue(), OOJSReportBadArguments(), OOJSReportWarning(), OOPlayerForScripting(), OOStringFromJSValue(), OOStringFromJSValueEvenIfNull(), PlayerEntity::setMissionDescription:forMission:, PlayerEntity::setMissionInstructions:forMission:, and PlayerEntity::setMissionInstructionsList:forMission:.

Referenced by MissionSetInstructions(), and MissionSetInstructionsKey().

Here is the call graph for this function:

Here is the caller graph for this function:

MissionSetInstructionsKey()

static JSBool MissionSetInstructionsKey ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 385 of file OOJSMission.m.

{
    return MissionSetInstructionsInternal(context, argc, vp, YES);
}

References MissionSetInstructionsInternal().

Here is the call graph for this function:

MissionSetProperty()

static JSBool MissionSetProperty ( JSContext * context, JSObject * this, jsid propID, JSBool strict, jsval * value )

static

Definition at line 224 of file OOJSMission.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    OOGUIScreenID exitScreen;
    PlayerEntity        *player = OOPlayerForScripting();
 
    switch (JSID_TO_INT(propID))
    {
        case kMission_exitScreen:
            exitScreen = OOGUIScreenIDFromJSValue(context, *value);
            [player setMissionExitScreen:exitScreen];
            return YES;
    
        default:
            OOJSReportBadPropertySelector(context, this, propID, sMissionProperties);
    }
    
    OOJSReportBadPropertyValue(context, this, propID, sMissionProperties, *value);
    return NO;
    
    OOJS_NATIVE_EXIT
}

References kMission_exitScreen, OOGUIScreenIDFromJSValue(), OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOJSReportBadPropertyValue(), OOPlayerForScripting(), PlayerEntity::setMissionExitScreen:, and sMissionProperties.

Here is the call graph for this function:

MissionUnmarkSystem()

static JSBool MissionUnmarkSystem ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 305 of file OOJSMission.m.

{
    OOJS_NATIVE_ENTER(context)
    
    PlayerEntity        *player = OOPlayerForScripting();
    unsigned i;
    int dest;
 
    // two pass. Once to validate, once to apply if they validate
    for (i=0;i<argc;i++)
    {
        if (!JS_ValueToInt32(context, OOJS_ARGV[i], &dest)) 
        {
            JS_ClearPendingException(context); // or JS_ValueToInt32 exception crashes JS engine
            if (!JSVAL_IS_OBJECT(OOJS_ARGV[i]))
            {
                OOJSReportBadArguments(context, @"Mission", @"unmarkSystem", MIN(argc, 1U), OOJS_ARGV, nil, @"numbers or objects");
                return NO;
            }
        }
    }
 
    BOOL result = YES;
    for (i=0;i<argc;i++)
    {
        if (JS_ValueToInt32(context, OOJS_ARGV[i], &dest)) 
        {
            OOStandardsDeprecated(@"Use of numbers for mission.unmarkSystem is deprecated");
            if (!OOEnforceStandards())
            {
                if (![player removeMissionDestinationMarker:[player defaultMarker:dest]]) {
                    result = NO;
                }
            }
        }
        else // must be object, from above
        {
            JS_ClearPendingException(context); // or JS_ValueToInt32 exception crashes JS engine
            NSDictionary *marker = OOJSNativeObjectFromJSObject(context, JSVAL_TO_OBJECT(OOJS_ARGV[i]));
            OOSystemID system = [marker oo_intForKey:@"system" defaultValue:-1];
            if (system >= 0)
            {
                if (![player removeMissionDestinationMarker:marker]) {
                    result = NO;
                }
            }
        }
    }
    
    OOJS_RETURN_BOOL(result);
    
    OOJS_NATIVE_EXIT
}

References PlayerEntity::defaultMarker:, MIN, nil, OOEnforceStandards(), OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_BOOL, OOJSNativeObjectFromJSObject(), OOJSReportBadArguments(), OOPlayerForScripting(), and OOStandardsDeprecated().

Here is the call graph for this function:

Variable Documentation

sCallbackFunction

jsval sCallbackFunction

static

Definition at line 54 of file OOJSMission.m.

Referenced by InitOOJSMission(), MissionRunCallback(), and MissionRunScreen().

sCallbackScript

OOJSScript* sCallbackScript = nil

static

Definition at line 56 of file OOJSMission.m.

Referenced by MissionRunCallback(), and MissionRunScreen().

sCallbackThis

jsval sCallbackThis

static

Definition at line 55 of file OOJSMission.m.

Referenced by InitOOJSMission(), MissionRunCallback(), and MissionRunScreen().

sMissionClass

JSClass sMissionClass

static

Initial value:

=
{
    "Mission",
    0,
    
    JS_PropertyStub,
    JS_PropertyStub,
    MissionGetProperty,
    MissionSetProperty,
    JS_EnumerateStub,
    JS_ResolveStub,
    JS_ConvertStub,
    JS_FinalizeStub
}

Definition at line 60 of file OOJSMission.m.

{
    "Mission",
    0,
    
    JS_PropertyStub,
    JS_PropertyStub,
    MissionGetProperty,
    MissionSetProperty,
    JS_EnumerateStub,
    JS_ResolveStub,
    JS_ConvertStub,
    JS_FinalizeStub
};

Referenced by InitOOJSMission().

sMissionMethods

JSFunctionSpec sMissionMethods[]

static

Initial value:

=
{
    
    { "addMessageText",         MissionAddMessageText,      1 },
    { "markSystem",             MissionMarkSystem,          1 },
    { "runScreen",              MissionRunScreen,           1 }, 
    { "setInstructions",        MissionSetInstructions,     1 },
    { "setInstructionsKey",     MissionSetInstructionsKey,  1 },
    { "unmarkSystem",           MissionUnmarkSystem,        1 },
    { "runShipLibrary",         MissionRunShipLibrary,      0 },
    { 0 }
}

Definition at line 94 of file OOJSMission.m.

{
    // JS name                  Function                    min args
    { "addMessageText",         MissionAddMessageText,      1 },
    { "markSystem",             MissionMarkSystem,          1 },
    { "runScreen",              MissionRunScreen,           1 }, // the callback function is optional!
    { "setInstructions",        MissionSetInstructions,     1 },
    { "setInstructionsKey",     MissionSetInstructionsKey,  1 },
    { "unmarkSystem",           MissionUnmarkSystem,        1 },
    { "runShipLibrary",         MissionRunShipLibrary,      0 },
    { 0 }
};

Referenced by InitOOJSMission().

sMissionObject

JSObject* sMissionObject

static

Definition at line 58 of file OOJSMission.m.

Referenced by InitOOJSMission(), and MissionRunScreen().

sMissionProperties

JSPropertySpec sMissionProperties[]

static

Initial value:

= 
{
    
    { "markedSystems", kMission_markedSystems, OOJS_PROP_READONLY_CB },
    { "screenID", kMission_screenID, OOJS_PROP_READONLY_CB },
    { "exitScreen", kMission_exitScreen, OOJS_PROP_READWRITE_CB },
    { 0 }
}

Definition at line 84 of file OOJSMission.m.

{
    // JS name                  ID                              flags
    { "markedSystems", kMission_markedSystems, OOJS_PROP_READONLY_CB },
    { "screenID", kMission_screenID, OOJS_PROP_READONLY_CB },
    { "exitScreen", kMission_exitScreen, OOJS_PROP_READWRITE_CB },
    { 0 }
};

Referenced by InitOOJSMission(), MissionGetProperty(), and MissionSetProperty().