OOScript Class Reference

#include <OOScript.h>

Inheritance diagram for OOScript:

Collaboration diagram for OOScript:

Instance Methods
(NSString *)	- name
(NSString *)	- scriptDescription
(NSString *)	- version
(NSString *)	- displayName
(BOOL)	- requiresTickle
(void)	- runWithTarget:
(NSString *)	- descriptionComponents [implementation]
(BOOL)	- callMethod:inContext:withArguments:count:result:

Class Methods
(NSArray *)	+ worldScriptsAtPath:
(NSArray *)	+ scriptsFromFileNamed:
(NSArray *)	+ scriptsFromList:
(NSArray *)	+ scriptsFromFileAtPath:
(id)	+ jsScriptFromFileNamed:properties:
(id)	+ jsAIScriptFromFileNamed:properties:

Detailed Description

Definition at line 41 of file OOScript.h.

Method Documentation

callMethod:inContext:withArguments:count:result:

- (BOOL) callMethod:		(jsid)	methodID
inContext:		(JSContext *)	context
withArguments:		(jsval *)	argv
count:		(intN)	argc
result:		(jsval *)	outResult

Reimplemented in OOJSScript.

Provided by category OOScript(JavaScriptEvents).

Definition at line 652 of file OOJSScript.m.

                   :(jsid)methodID
          inContext:(JSContext *)context
      withArguments:(jsval *)argv count:(intN)argc
             result:(jsval *)outResult
{
    return NO;
}

Referenced by PlayerEntity::doWorldEventUntilMissionScreen:, PlayerEntity::doWorldScriptEvent:inContext:withArguments:count:timeLimit:, and OOCommodities(OOPrivate)::modifyGood:withScript:atStation:inSystem:localMode:.

Here is the caller graph for this function:

descriptionComponents

- (NSString *) descriptionComponents

implementation

Reimplemented in OOJSScript.

Definition at line 250 of file OOScript.m.

{
    return [NSString stringWithFormat:@"\"%@\" version %@", [self name], [self version]];
}

References descriptionComponents, name, and version.

Referenced by OOJSScript::descriptionComponents, and descriptionComponents.

Here is the call graph for this function:

Here is the caller graph for this function:

displayName

- (NSString *) displayName

Definition at line 277 of file OOScript.m.

{
    NSString *name = [self name];
    NSString *version = [self version];
    
    if (version != nil)  return [NSString stringWithFormat:@"%@ %@", name, version];
    else if (name != nil)  return [NSString stringWithFormat:@"%@", name];
    else  return nil;
}

References displayName, name, nil, and version.

Referenced by displayName, OOJSScript::initWithPath:properties:, ResourceManager::loadScripts, and OOPListScript::runWithTarget:.

Here is the call graph for this function:

Here is the caller graph for this function:

jsAIScriptFromFileNamed:properties:

+ (id) jsAIScriptFromFileNamed:		(NSString *)	fileName
properties:		(NSDictionary *)	properties

Definition at line 221 of file OOScript.m.

                             :(NSString *)fileName properties:(NSDictionary *)properties
{
    NSString            *extension = nil;
    NSString            *path = nil;
    
    if ([fileName length] == 0)  return nil;
    
    extension = [[fileName pathExtension] lowercaseString];
    if ([extension isEqualToString:@"js"] || [extension isEqualToString:@"es"])
    {
        path = [ResourceManager pathForFileNamed:fileName inFolder:@"AIs"];
        if (path == nil)
        {
            OOLogERR(@"script.load.notFound", @"Could not find script file %@.", fileName);
            return nil;
        }
        return [OOJSScript scriptWithPath:path properties:properties];
    }
    else if ([extension isEqualToString:@"plist"])
    {
        OOLogERR(@"script.load.badName", @"Can't load script named %@ - legacy scripts are not supported in this context.", fileName);
        return nil;
    }
    
    OOLogERR(@"script.load.badName", @"Don't know how to load a script from %@.", fileName);
    return nil;
}

References nil, OOLogERR, ResourceManager::pathForFileNamed:inFolder:, and OOJSScript::scriptWithPath:properties:.

Referenced by ShipEntity(AI)::setAIScript:.

Here is the call graph for this function:

Here is the caller graph for this function:

jsScriptFromFileNamed:properties:

+ (id) jsScriptFromFileNamed:		(NSString *)	fileName
properties:		(NSDictionary *)	properties

Definition at line 192 of file OOScript.m.

                           :(NSString *)fileName properties:(NSDictionary *)properties
{
    NSString            *extension = nil;
    NSString            *path = nil;
    
    if ([fileName length] == 0)  return nil;
    
    extension = [[fileName pathExtension] lowercaseString];
    if ([extension isEqualToString:@"js"] || [extension isEqualToString:@"es"])
    {
        path = [ResourceManager pathForFileNamed:fileName inFolder:@"Scripts"];
        if (path == nil)
        {
            OOLogERR(@"script.load.notFound", @"Could not find script file %@.", fileName);
            return nil;
        }
        return [OOJSScript scriptWithPath:path properties:properties];
    }
    else if ([extension isEqualToString:@"plist"])
    {
        OOLogERR(@"script.load.badName", @"Can't load script named %@ - legacy scripts are not supported in this context.", fileName);
        return nil;
    }
    
    OOLogERR(@"script.load.badName", @"Don't know how to load a script from %@.", fileName);
    return nil;
}

References nil, OOLogERR, ResourceManager::pathForFileNamed:inFolder:, and OOJSScript::scriptWithPath:properties:.

Referenced by Universe::addConditionScripts:, PlayerEntity(Scripting)::addEqScriptForKey:, PlayerEntity::commodityScriptNamed:, OOJavaScriptEngine(Private)::createMainThreadContext, OOCharacter::setCharacterScript:, OOVisualEffectEntity::setScript:, ShipEntity::setShipScript:, PlayerEntity::setUpAndConfirmOK:saveGame:, and PlayerEntity::setUpShipFromDictionary:.

Here is the call graph for this function:

Here is the caller graph for this function:

name

- (NSString *) name

Reimplemented in OOPListScript.

Definition at line 256 of file OOScript.m.

{
    OOLogERR(kOOLogSubclassResponsibility, @"%@", @"OOScript should not be used directly!");
    return nil;
}

References kOOLogSubclassResponsibility, name, nil, and OOLogERR.

Referenced by descriptionComponents, displayName, ResourceManager::loadScripts, name, and scriptsFromList:.

Here is the call graph for this function:

Here is the caller graph for this function:

requiresTickle

- (BOOL) requiresTickle

Reimplemented in OOPListScript.

Definition at line 288 of file OOScript.m.

{
    return NO;
}

References requiresTickle.

Referenced by requiresTickle.

Here is the call graph for this function:

Here is the caller graph for this function:

runWithTarget:

- (void) runWithTarget:

(Entity *)

target

Reimplemented in OOJSScript, and OOPListScript.

Definition at line 294 of file OOScript.m.

                     :(Entity *)target
{
    OOLogERR(kOOLogSubclassResponsibility, @"%@", @"OOScript should not be used directly!");
}

References kOOLogSubclassResponsibility, and OOLogERR.

scriptDescription

- (NSString *) scriptDescription

Reimplemented in OOJSScript, and OOPListScript.

Definition at line 263 of file OOScript.m.

{
    OOLogERR(kOOLogSubclassResponsibility, @"%@", @"OOScript should not be used directly!");
    return nil;
}

References kOOLogSubclassResponsibility, nil, OOLogERR, and scriptDescription.

Referenced by scriptDescription.

Here is the call graph for this function:

Here is the caller graph for this function:

scriptsFromFileAtPath:

+ (NSArray *) scriptsFromFileAtPath:

(NSString *)

filePath

Definition at line 163 of file OOScript.m.

                                  :(NSString *)filePath
{
    // oo_oxzFile always returns false for directories
    if (![[NSFileManager defaultManager] oo_oxzFileExistsAtPath:filePath]) return nil;
    
    NSString *extension = [[filePath pathExtension] lowercaseString];
    
    if ([extension isEqualToString:@"js"] || [extension isEqualToString:@"es"])
    {
        NSArray     *result = nil;
        OOScript    *script = [OOJSScript scriptWithPath:filePath properties:nil];
        if (script != nil) result = [NSArray arrayWithObject:script];
        return result;
    }
    else if ([extension isEqualToString:@"plist"])
    {
        OOStandardsDeprecated([NSString stringWithFormat:@"Legacy script %@ is deprecated",filePath]);
        if (OOEnforceStandards())
        {
            return nil;
        }
        return [OOPListScript scriptsInPListFile:filePath];
    }
    
    OOLogERR(@"script.load.badName", @"Don't know how to load a script from %@.", filePath);
    return nil;
}

References nil, OOEnforceStandards(), OOLogERR, OOStandardsDeprecated(), OOPListScript::scriptsInPListFile:, and OOJSScript::scriptWithPath:properties:.

Referenced by scriptsFromFileNamed:.

Here is the call graph for this function:

Here is the caller graph for this function:

scriptsFromFileNamed:

+ (NSArray *) scriptsFromFileNamed:

(NSString *)

fileName

Definition at line 126 of file OOScript.m.

                                 :(NSString *)fileName
{
    NSArray *result = nil;
    NSString *path = [ResourceManager pathForFileNamed:fileName inFolder:@"Scripts"];
    if (path != nil)
    {
        result = [self scriptsFromFileAtPath:path];
    }
    
    if (result == nil)
    {
        OOLogERR(@"script.load.notFound", @"Could not find script file %@.", fileName);
    }
    
    return result;
}

References nil, OOLogERR, ResourceManager::pathForFileNamed:inFolder:, and scriptsFromFileAtPath:.

Referenced by scriptsFromList:.

Here is the call graph for this function:

Here is the caller graph for this function:

scriptsFromList:

+ (NSArray *) scriptsFromList:

(NSArray *)

fileNames

Definition at line 144 of file OOScript.m.

                            :(NSArray *)fileNames
{
    NSEnumerator        *nameEnum = nil;
    NSString            *name = nil;
    NSMutableArray      *result = nil;
    NSArray             *scripts = nil;
    
    result = [NSMutableArray arrayWithCapacity:[fileNames count]];
    
    for (nameEnum = [fileNames objectEnumerator]; (name = [nameEnum nextObject]); )
    {
        scripts = [self scriptsFromFileNamed:name];
        if (scripts != nil)  [result addObjectsFromArray:scripts];
    }
    
    return result;
}

References name, nil, and scriptsFromFileNamed:.

Referenced by worldScriptsAtPath:.

Here is the call graph for this function:

Here is the caller graph for this function:

version

- (NSString *) version

Reimplemented in OOPListScript.

Definition at line 270 of file OOScript.m.

{
    OOLogERR(kOOLogSubclassResponsibility, @"%@", @"OOScript should not be used directly!");
    return nil;
}

References kOOLogSubclassResponsibility, nil, OOLogERR, and version.

Referenced by descriptionComponents, displayName, and version.

Here is the call graph for this function:

Here is the caller graph for this function:

worldScriptsAtPath:

+ (NSArray *) worldScriptsAtPath:

(NSString *)

path

Definition at line 45 of file OOScript.m.

                               :(NSString *)path
{
    NSFileManager       *fmgr = nil;
    NSString            *filePath = nil;
    NSArray             *names = nil;
    NSArray             *result = nil;
    id                  script = nil;
    BOOL                foundScript = NO;
    
    fmgr = [NSFileManager defaultManager];
    
    // First, look for world-scripts.plist.
    filePath = [path stringByAppendingPathComponent:@"world-scripts.plist"];
    if (filePath != nil)
    {
        names = OOArrayFromFile(filePath);
        if (names != nil)
        {
            foundScript = YES;
            result = [self scriptsFromList:names];
        }
    }
    
    // Second, try to load a JavaScript.
    if (result == nil)
    {
        filePath = [path stringByAppendingPathComponent:@"script.js"];
        if ([fmgr oo_oxzFileExistsAtPath:filePath]) foundScript = YES;
        else
        {
            filePath = [path stringByAppendingPathComponent:@"script.es"];
            if ([fmgr oo_oxzFileExistsAtPath:filePath]) foundScript = YES;
        }
        if (foundScript)
        {
            OOLog(kOOLogLoadScriptJavaScript, @"Trying to load JavaScript script %@", filePath);
            OOLogIndentIf(kOOLogLoadScriptJavaScript);
            
            script = [OOJSScript scriptWithPath:filePath properties:nil];
            if (script != nil)
            {
                result = [NSArray arrayWithObject:script];
                OOLog(kOOLogLoadScriptOK, @"Successfully loaded JavaScript script %@", filePath);
            }
            else  OOLogERR(kOOLogLoadScriptParseError, @"Failed to load JavaScript script %@", filePath);
            
            OOLogOutdentIf(kOOLogLoadScriptJavaScript);
        }
    }
    
    // Third, try to load a plist script.
    if (result == nil)
    {
        filePath = [path stringByAppendingPathComponent:@"script.plist"];
        if ([fmgr oo_oxzFileExistsAtPath:filePath])
        {
            OOStandardsDeprecated([NSString stringWithFormat:@"Legacy script %@ is deprecated",filePath]);
            if (!OOEnforceStandards())
            {
                foundScript = YES;
                OOLog(kOOLogLoadScriptPList, @"Trying to load property list script %@", filePath);
                OOLogIndentIf(kOOLogLoadScriptPList);
                
                result = [OOPListScript scriptsInPListFile:filePath];
                if (result != nil)  OOLog(kOOLogLoadScriptOK, @"Successfully loaded property list script %@", filePath);
                else  OOLogERR(kOOLogLoadScriptParseError, @"Failed to load property list script %@", filePath);
            
                OOLogOutdentIf(kOOLogLoadScriptPList);
            }
        }
    }
    
    if (result == nil && foundScript)
    {
        OOLog(kOOLogLoadScriptNone, @"No script could be loaded from %@", path);
    }
    
    return result;
}

References kOOLogLoadScriptJavaScript, kOOLogLoadScriptNone, kOOLogLoadScriptOK, kOOLogLoadScriptParseError, kOOLogLoadScriptPList, nil, OOArrayFromFile(), OOEnforceStandards(), OOLog, OOLogERR, OOLogIndentIf, OOLogOutdentIf, OOStandardsDeprecated(), scriptsFromList:, OOPListScript::scriptsInPListFile:, and OOJSScript::scriptWithPath:properties:.

Referenced by ResourceManager::loadScripts.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/Core/Scripting/OOScript.h
• src/Core/Scripting/OOScript.m