OOSystemInfo Class Reference

Inheritance diagram for OOSystemInfo:

Collaboration diagram for OOSystemInfo:

Instance Methods
(id)	- initWithGalaxy:system:
(id)	- valueForKey:
(void)	- setValue:forKey:
(NSArray *)	- allKeys
(OOGalaxyID)	- galaxy
(OOSystemID)	- system
(id)	- init [implementation]
(void)	- dealloc [implementation]
(NSString *)	- descriptionComponents [implementation]
(NSString *)	- shortDescriptionComponents [implementation]
(NSString *)	- oo_jsClassName [implementation]
(BOOL)	- isEqual: [implementation]
(NSUInteger)	- hash [implementation]
(NSPoint)	- coordinates [implementation]
(jsval)	- oo_jsValueInContext: [implementation]

Private Attributes
OOGalaxyID	_galaxy
OOSystemID	_system
NSString *	_planetKey

Detailed Description

Definition at line 117 of file OOJSSystemInfo.m.

Method Documentation

allKeys

- (NSArray *) allKeys

Definition at line 122 of file OOJSSystemInfo.m.

{
    if ([UNIVERSE inInterstellarSpace] && _system == -1) 
    {
        return [[UNIVERSE currentSystemData] allKeys];
    }
    return [UNIVERSE systemDataKeysForGalaxy:_galaxy planet:_system];
}

Referenced by SystemInfoEnumerate().

Here is the caller graph for this function:

coordinates

- (NSPoint) coordinates

implementation

Definition at line 122 of file OOJSSystemInfo.m.

{
    if ([UNIVERSE inInterstellarSpace] && _system == -1) 
    {
        return [PLAYER galaxy_coordinates];
    }
    return [UNIVERSE coordinatesForSystem:_system];
}

Referenced by SystemInfoDistanceToSystem(), and SystemInfoGetProperty().

Here is the caller graph for this function:

dealloc

- (void) dealloc

implementation

Definition at line 122 of file OOJSSystemInfo.m.

{
    [_planetKey release];
    
    [super dealloc];
}

descriptionComponents

- (NSString *) descriptionComponents

implementation

Definition at line 122 of file OOJSSystemInfo.m.

{
    return [NSString stringWithFormat:@"galaxy %u, system %i", _galaxy, _system];
}

galaxy

- (OOGalaxyID) galaxy

Definition at line 122 of file OOJSSystemInfo.m.

{
    return _galaxy;
}

Referenced by GetJSSystemInfoForSystem(), SystemInfoDistanceToSystem(), SystemInfoGetProperty(), SystemInfoRouteToSystem(), SystemInfoSamplePrice(), SystemInfoSetPropertyMethod(), and SystemInfoStaticFilteredSystems().

Here is the caller graph for this function:

hash

- (NSUInteger) hash

implementation

Definition at line 122 of file OOJSSystemInfo.m.

{
    NSUInteger hash = _galaxy;
    hash <<= 16;
    hash |= (uint16_t)_system;
    return hash;
}

init

- (id) init

implementation

Definition at line 122 of file OOJSSystemInfo.m.

{
    [self release];
    return nil;
}

initWithGalaxy:system:

- (id) initWithGalaxy:		(OOGalaxyID)	galaxy
system:		(OOSystemID)	system

Definition at line 122 of file OOJSSystemInfo.m.

                     :(OOGalaxyID)galaxy system:(OOSystemID)system
{
    if (galaxy > kOOMaximumGalaxyID || system > kOOMaximumSystemID || system < kOOMinimumSystemID)
    {
        [self release];
        return nil;
    }
    
    if ((self = [super init]))
    {
        _galaxy = galaxy;
        _system = system;
        _planetKey = [[NSString stringWithFormat:@"%u %i", galaxy, system] retain];
    }
    return self;
}

isEqual:

- (BOOL) isEqual: (id) other

implementation

Definition at line 122 of file OOJSSystemInfo.m.

                :(id)other
{
    return other == self ||
           ([other isKindOfClass:[OOSystemInfo class]] &&
            [other galaxy] == _galaxy &&
            [other system] == _system);
                     
}

oo_jsClassName

- (NSString *) oo_jsClassName

implementation

Definition at line 122 of file OOJSSystemInfo.m.

{
    return @"SystemInfo";
}

oo_jsValueInContext:

- (jsval) oo_jsValueInContext: (JSContext *) context

implementation

Definition at line 122 of file OOJSSystemInfo.m.

                             :(JSContext *)context
{
    JSObject                    *jsSelf = NULL;
    jsval                       result = JSVAL_NULL;
    
    jsSelf = JS_NewObject(context, &sSystemInfoClass, sSystemInfoPrototype, NULL);
    if (jsSelf != NULL)
    {
        if (!JS_SetPrivate(context, jsSelf, [self retain]))  jsSelf = NULL;
    }
    if (jsSelf != NULL)  result = OBJECT_TO_JSVAL(jsSelf);
    
    return result;
}

setValue:forKey:

- (void) setValue:		(id)	value
forKey:		(NSString *)	key

Definition at line 122 of file OOJSSystemInfo.m.

                 :(id)value forKey:(NSString *)key
{
    NSString *manifest = [[OOJSScript currentlyRunningScript] propertyNamed:kLocalManifestProperty];
 
    [UNIVERSE setSystemDataForGalaxy:_galaxy planet:_system key:key value:value  fromManifest:manifest forLayer:OO_LAYER_OXP_DYNAMIC];
}

Referenced by SystemInfoSetProperty().

Here is the caller graph for this function:

shortDescriptionComponents

- (NSString *) shortDescriptionComponents

implementation

Definition at line 122 of file OOJSSystemInfo.m.

{
    return _planetKey;
}

system

- (OOSystemID) system

Definition at line 122 of file OOJSSystemInfo.m.

{
    return _system;
}

Referenced by GetJSSystemInfoForSystem(), SystemInfoGetProperty(), SystemInfoRouteToSystem(), SystemInfoSamplePrice(), SystemInfoSetPropertyMethod(), and SystemInfoStaticFilteredSystems().

Here is the caller graph for this function:

valueForKey:

- (id) valueForKey:

(NSString *)

key

Definition at line 122 of file OOJSSystemInfo.m.

                  :(NSString *)key
{
    if ([UNIVERSE inInterstellarSpace] && _system == -1) 
    {
        return [[UNIVERSE currentSystemData] objectForKey:key];
    }
    return [UNIVERSE systemDataForGalaxy:_galaxy planet:_system key:key];
}

Referenced by SystemInfoGetProperty(), and SystemInfoSamplePrice().

Here is the caller graph for this function:

Member Data Documentation

_galaxy

- (OOGalaxyID) _galaxy

private

Definition at line 120 of file OOJSSystemInfo.m.

_planetKey

- (NSString*) _planetKey

private

Definition at line 122 of file OOJSSystemInfo.m.

_system

- (OOSystemID) _system

private

Definition at line 121 of file OOJSSystemInfo.m.

---

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

• src/Core/Scripting/OOJSSystemInfo.m