StationEntity(OOPrivate) Category Reference

Instance Methods
(void)	- pullInShipIfPermitted:
(void)	- addShipToStationCount:
(void)	- addShipToLaunchQueue:withPriority:
(unsigned)	- countOfShipsInLaunchQueueWithPrimaryRole:
(NSDictionary *)	- holdPositionInstructionForShip:

Detailed Description

Definition at line 53 of file StationEntity.m.

Method Documentation

addShipToLaunchQueue:withPriority:

- (void) addShipToLaunchQueue:		(ShipEntity *)	ship
withPriority:		(BOOL)	priority

Extends class StationEntity.

Definition at line 448 of file StationEntity.m.

                             :(ShipEntity *)ship withPriority:(BOOL)priority
{
    NSEnumerator    *subEnum = nil;
    DockEntity      *sub = nil;
    unsigned            threshold = 0;
 
    // quickest launch if we assign ships to those bays with no incoming ships
    // and spread the ships evenly around those bays
    // much easier if the station has at least one launch-only dock
    while (threshold < 16)
    {
        for (subEnum = [self dockSubEntityEnumerator]; (sub = [subEnum nextObject]); )
        {
            if (sub != player_reserved_dock)
            {
                if ([sub countOfShipsInDockingQueue] == 0)
                {
                    if ([sub allowsLaunching] && [sub countOfShipsInLaunchQueue] <= threshold)
                    {
                        if ([sub allowsLaunchingOf:ship])
                        {
                            [sub addShipToLaunchQueue:ship withPriority:priority];
                            return;
                        }
                    }
                }
            }
        }
        threshold++;
    }
    // if we get this far, all docks have at least some incoming traffic.
    // usually most efficient (since launching is far faster than docking)
    // to assign all ships to the *same* dock with the smallest incoming queue
    // rather than to try spreading them out across several queues
    // also stops escorts being launched before their mothership 
    threshold = 0;
    while (threshold < 16)
    {
        for (subEnum = [self dockSubEntityEnumerator]; (sub = [subEnum nextObject]); )
        {
            /* so this time as long as it allows launching only check
             * the docking queue size so long as enumerator order is
             * deterministic, this will assign every launch this
             * update to the same dock (edge case where new docking
             * ship appears in the middle, probably not a problem) */
            if ([sub allowsLaunching] && [sub countOfShipsInDockingQueue] <= threshold)
            {
                if ([sub allowsLaunchingOf:ship])
                {
                    [sub addShipToLaunchQueue:ship withPriority:priority];
                    return;
                }
            }
 
        }
        threshold++;
    }
    
    OOLog(@"station.launchShip.failed", @"Cancelled launch for a %@ with role %@, as the %@ has too many ships in its launch queue(s) or no suitable launch docks.",
              [ship displayName], [ship primaryRole], [self displayName]);
}

addShipToStationCount:

- (void) addShipToStationCount:

(ShipEntity *)

ship

Extends class StationEntity.

Definition at line 448 of file StationEntity.m.

                              :(ShipEntity *) ship
{
    if ([ship isShuttle])  docked_shuttles++;
    else if ([ship isTrader] && ![ship isPlayer])  docked_traders++;
    else if (([ship isPolice] && ![ship isEscort]) || [ship hasPrimaryRole:@"defense_ship"])
    {
        if (0 < defenders_launched)  defenders_launched--;
    }
    else if ([ship hasPrimaryRole:@"scavenger"] || [ship hasPrimaryRole:@"miner"])  // treat miners and scavengers alike!
    {
        if (0 < scavengers_launched)  scavengers_launched--;
    }
}

countOfShipsInLaunchQueueWithPrimaryRole:

- (unsigned) countOfShipsInLaunchQueueWithPrimaryRole:

(NSString *)

role

Extends class StationEntity.

Definition at line 448 of file StationEntity.m.

                                                     :(NSString *)role
{
    unsigned result = 0;
    NSEnumerator    *subEnum = nil;
    DockEntity* sub = nil;
    for (subEnum = [self dockSubEntityEnumerator]; (sub = [subEnum nextObject]); )
    {
        result += [sub countOfShipsInLaunchQueueWithPrimaryRole:role];
    }
    return result;
}

holdPositionInstructionForShip:

- (NSDictionary *) holdPositionInstructionForShip:

(ShipEntity *)

ship

Extends class StationEntity.

Definition at line 448 of file StationEntity.m.

                                                :(ShipEntity *)ship
{
    if (![_shipsOnHold containsObject:ship])
    {
        [self sendExpandedMessage:@"[station-acknowledges-hold-position]" toShip:ship];
        [_shipsOnHold addObject:ship];
    }
    
    return OOMakeDockingInstructions(self, [ship position], 0, 100, @"HOLD_POSITION", nil, NO, -1);
}

pullInShipIfPermitted:

- (void) pullInShipIfPermitted:

(ShipEntity *)

ship

Extends class StationEntity.

Definition at line 448 of file StationEntity.m.

                              :(ShipEntity *)ship
{
    [ship enterDock:self]; // dock performs permitted checks
}

---

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

• src/Core/Entities/StationEntity.m