OOPListScript Class Reference

#include <OOPListScript.h>

Inheritance diagram for OOPListScript:

Collaboration diagram for OOPListScript:

Instance Methods
(void)	- dealloc [implementation]
(NSString *)	- name [implementation]
(NSString *)	- scriptDescription [implementation]
(NSString *)	- version [implementation]
(BOOL)	- requiresTickle [implementation]
(void)	- runWithTarget: [implementation]
(id)	- initWithName:scriptArray:metadata: [implementation]
Instance Methods inherited from OOScript
(NSString *)	- displayName
(NSString *)	- descriptionComponents [implementation]
(BOOL)	- callMethod:inContext:withArguments:count:result:

Class Methods
(NSArray *)	+ scriptsInPListFile:
(NSArray *)	+ scriptsFromDictionaryOfScripts:filePath: [implementation]
(NSArray *)	+ loadCachedScripts: [implementation]
Class Methods inherited from OOScript
(NSArray *)	+ worldScriptsAtPath:
(NSArray *)	+ scriptsFromFileNamed:
(NSArray *)	+ scriptsFromList:
(NSArray *)	+ scriptsFromFileAtPath:
(id)	+ jsScriptFromFileNamed:properties:
(id)	+ jsAIScriptFromFileNamed:properties:

Private Attributes
NSArray *	_script
NSDictionary *	_metadata

Detailed Description

Definition at line 36 of file OOPListScript.h.

Method Documentation

dealloc

- (void) dealloc

implementation

Definition at line 39 of file OOPListScript.m.

{
    [_script release];
    [_metadata release];
    
    [super dealloc];
}

initWithName:scriptArray:metadata:

- (id) initWithName: (NSString *)  name scriptArray: (NSArray *)  script metadata: (NSDictionary *)  metadata

implementation

Provided by category OOPListScript(SetUp).

Definition at line 39 of file OOPListScript.m.

                  :(NSString *)name scriptArray:(NSArray *)script metadata:(NSDictionary *)metadata
{
    self = [super init];
    if (self != nil)
    {
        _script = [script retain];
        if (name != nil)
        {
            if (metadata == nil)  metadata = [NSDictionary dictionaryWithObject:name forKey:kMDKeyName];
            else
            {
                NSMutableDictionary *mutableMetadata = [[metadata mutableCopy] autorelease];
                [mutableMetadata setObject:name forKey:kMDKeyName];
                metadata = mutableMetadata;
            }
        }
        _metadata = [metadata copy];
    }
    
    return self;
}

loadCachedScripts:

+ (NSArray *) loadCachedScripts: (NSDictionary *)  cachedScripts

implementation

Provided by category OOPListScript(SetUp).

Definition at line 39 of file OOPListScript.m.

                               :(NSDictionary *)cachedScripts
{
    NSString            *key = nil;
    
    NSMutableArray *result = [NSMutableArray arrayWithCapacity:[cachedScripts count]];
    
    foreachkey (key, cachedScripts)
    {
        NSDictionary *cacheValue = [cachedScripts oo_dictionaryForKey:key];
        NSArray *scriptArray = [cacheValue oo_arrayForKey:kKeyScript];
        NSDictionary *metadata = [cacheValue oo_dictionaryForKey:kKeyMetadata];
        OOPListScript *script = [[self alloc] initWithName:key scriptArray:scriptArray metadata:metadata];
        if (script != nil)
        {
            [result addObject:script];
            [script release];
        }
    }
    
    return [[result copy] autorelease];
}

name

- (NSString *) name

implementation

Reimplemented from OOScript.

Definition at line 39 of file OOPListScript.m.

{
    return [_metadata objectForKey:kMDKeyName];
}

requiresTickle

- (BOOL) requiresTickle

implementation

Reimplemented from OOScript.

Definition at line 39 of file OOPListScript.m.

{
    return YES;
}

runWithTarget:

- (void) runWithTarget: (Entity *)  target

implementation

Reimplemented from OOScript.

Definition at line 39 of file OOPListScript.m.

                     :(Entity *)target
{
    if (target != nil && ![target isKindOfClass:[ShipEntity class]])
    {
        OOLog(@"script.legacy.run.badTarget", @"Expected ShipEntity or nil for target, got %@.", [target class]);
        return;
    }
    
    OOLog(@"script.legacy.run", @"Running script %@", [self displayName]);
    OOLogIndentIf(@"script.legacy.run");
    
    [PLAYER runScriptActions:_script
             withContextName:[self name]
                   forTarget:(ShipEntity *)target];
    
    OOLogOutdentIf(@"script.legacy.run");
}

scriptDescription

- (NSString *) scriptDescription

implementation

Reimplemented from OOScript.

Definition at line 39 of file OOPListScript.m.

{
    return [_metadata objectForKey:kMDKeyDescription];
}

scriptsFromDictionaryOfScripts:filePath:

+ (NSArray *) scriptsFromDictionaryOfScripts: (NSDictionary *)  dictionary filePath: (NSString *)  filePath

implementation

Provided by category OOPListScript(SetUp).

Definition at line 39 of file OOPListScript.m.

                                           :(NSDictionary *)dictionary filePath:(NSString *)filePath
{
    NSMutableArray      *result = nil;
    NSString            *key = nil;
    NSArray             *scriptArray = nil;
    NSDictionary        *metadata = nil;
    NSMutableDictionary *cachedScripts = nil;
    OOPListScript       *script = nil;
    
    NSUInteger count = [dictionary count];
    result = [NSMutableArray arrayWithCapacity:count];
    cachedScripts = [NSMutableDictionary dictionaryWithCapacity:count];
    
    metadata = [dictionary objectForKey:kKeyMetadata];
    if (![metadata isKindOfClass:[NSDictionary class]]) metadata = nil;
    
    foreachkey (key, dictionary)
    {
        scriptArray = [dictionary objectForKey:key];
        if ([key isKindOfClass:[NSString class]] &&
            [scriptArray isKindOfClass:[NSArray class]] &&
            ![key isEqual:kKeyMetadata])
        {
            scriptArray = OOSanitizeLegacyScript(scriptArray, key, NO);
            if (scriptArray != nil)
            {
                script = [[self alloc] initWithName:key scriptArray:scriptArray metadata:metadata];
                if (script != nil)
                {
                    [result addObject:script];
                    [cachedScripts setObject:[NSDictionary dictionaryWithObjectsAndKeys:scriptArray, kKeyScript, metadata, kKeyMetadata, nil] forKey:key];
                    
                    [script release];
                }
            }
        }
    }
    
    [[OOCacheManager sharedCache] setObject:cachedScripts forKey:filePath inCache:kCacheName];
    
    return [[result copy] autorelease];
}

scriptsInPListFile:

+ (NSArray *) scriptsInPListFile:

(NSString *)

filePath

Definition at line 39 of file OOPListScript.m.

                               :(NSString *)filePath
{
    NSDictionary *cachedScripts = [[OOCacheManager sharedCache] objectForKey:filePath inCache:kCacheName];
    if (cachedScripts != nil)
    {
        return [self loadCachedScripts:cachedScripts];
    }
    else
    {
        NSDictionary *dict = OODictionaryFromFile(filePath);
        if (dict == nil)  return nil;
        return [self scriptsFromDictionaryOfScripts:dict filePath:filePath];
    }
}

Referenced by OOScript::descriptionComponents.

Here is the caller graph for this function:

version

- (NSString *) version

implementation

Reimplemented from OOScript.

Definition at line 39 of file OOPListScript.m.

{
    return [_metadata objectForKey:kMDKeyVersion];
}

Member Data Documentation

_metadata

- (NSDictionary*) _metadata

private

Definition at line 40 of file OOPListScript.h.

_script

- (NSArray*) _script

private

Definition at line 39 of file OOPListScript.h.

---

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

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