ShipEntity(ScriptMethods) Category Reference

#include <ShipEntityScriptMethods.h>

Instance Methods
(ShipEntity *)	- ejectShipOfType:
(ShipEntity *)	- ejectShipOfRole:
(NSArray *)	- spawnShipsWithRole:count:

Detailed Description

Definition at line 31 of file ShipEntityScriptMethods.h.

Method Documentation

ejectShipOfRole:

- (ShipEntity *) ejectShipOfRole:

(NSString *)

role

Definition at line 31 of file ShipEntityScriptMethods.m.

                                :(NSString *)role
{
    ShipEntity      *item = nil;
    
    if (role != nil)
    {
        item = [[UNIVERSE newShipWithRole:role] autorelease];
        if (item != nil)  [self dumpItem:item];
    }
    
    return item;
}

References ShipEntity::dumpItem:, and nil.

Here is the call graph for this function:

ejectShipOfType:

- (ShipEntity *) ejectShipOfType:

(NSString *)

shipKey

Definition at line 31 of file ShipEntityScriptMethods.m.

                                :(NSString *)shipKey
{
    ShipEntity      *item = nil;
    
    if (shipKey != nil)
    {
        item = [[UNIVERSE newShipWithName:shipKey] autorelease];
        if (item != nil)  [self dumpItem:item];
    }
    
    return item;
}

spawnShipsWithRole:count:

- (NSArray *) spawnShipsWithRole:		(NSString *)	role
count:		(NSUInteger)	count

Definition at line 31 of file ShipEntityScriptMethods.m.

                                :(NSString *)role count:(NSUInteger)count
{
    ShipEntity              *ship = [self rootShipEntity];  // FIXME: (EMMSTRAN) implement an -absolutePosition method, use that in spawnShipWithRole:near:, and use self instead of root.
    ShipEntity              *spawned = nil;
    NSMutableArray          *result = nil;
    
    if (count == 0)  return [NSArray array];
    
    OOLog(kOOLogNoteAddShips, @"Spawning %llu x '%@' near %@ %d", count, role, [self shortDescription], [self universalID]);
    
    result = [NSMutableArray arrayWithCapacity:count];
    
    do
    {
        spawned = [UNIVERSE spawnShipWithRole:role near:ship];
        if (spawned != nil)
        {
            [spawned setTemperature:[self randomEjectaTemperature]];
            if ([self isMissileFlagSet] && [[spawned shipInfoDictionary] oo_boolForKey:@"is_submunition"])
            {
                [spawned setOwner:[self owner]];
                [spawned addTarget:[self primaryTarget]];
                [spawned setIsMissileFlag:YES];
            }
            if ([spawned isMine])
            {
                [spawned setOwner:self];
            }
            [result addObject:spawned];
        }
    }
    while (--count);
    
    return result;
}

---

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

• src/Core/Entities/ShipEntityScriptMethods.h
• src/Core/Entities/ShipEntityScriptMethods.m