OOScript.h

Go to the documentation of this file.

/*
 
OOScript.h
 
Abstract base class for scripts.
Currently, Oolite supports two types of script: the original property list
scripts and JavaScript scripts. OOS, a format that translated into plist
scripts, was supported until 1.69.1, but never used. OOScript unifies the
interfaces to the script types and abstracts loading. Additionally, it falls
back to a more "primitive" script if loading of one type fails; specifically,
the order of precedence is:
    script.js       (JavaScript)
//  script.oos      (OOS)
    script.plist    (property list)
 
Oolite
Copyright (C) 2004-2013 Giles C Williams and contributors
 
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301, USA.
 
*/
 
#import <Foundation/Foundation.h>
 
@class Entity;
 
 
@interface OOScript: NSObject
 
/*  Looks for path/world-scripts.plist, path/script.js, then path/script.plist.
    May return zero or more scripts.
*/
+ (NSArray *)worldScriptsAtPath:(NSString *)path;
 
//  Load named scripts from Scripts folders.
+ (NSArray *)scriptsFromFileNamed:(NSString *)fileName;
+ (NSArray *)scriptsFromList:(NSArray *)fileNames;
 
+ (NSArray *)scriptsFromFileAtPath:(NSString *)filePath;
 
//  Load a single JavaScript script.
+ (id)jsScriptFromFileNamed:(NSString *)fileName properties:(NSDictionary *)properties;
//  As above, but load from the "AIs" directory
+ (id)jsAIScriptFromFileNamed:(NSString *)fileName properties:(NSDictionary *)properties;
 
- (NSString *)name;
- (NSString *)scriptDescription;
- (NSString *)version;
- (NSString *)displayName;  // "name version" if version is defined, otherwise just "name".
 
- (BOOL) requiresTickle;
- (void)runWithTarget:(Entity *)target;
 
@end