PlayerEntityScriptMethods.h

Go to the documentation of this file.

/*
 
PlayerEntityScriptMethods.h
 
Methods for use by scripting mechanisms.
 
 
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 "PlayerEntity.h"
 
 
@interface PlayerEntity (ScriptMethods)
 
- (unsigned) score;
- (void) setScore:(unsigned)value;
 
- (double) creditBalance;
- (void) setCreditBalance:(double)value;
 
- (NSString *) dockedStationName;
- (NSString *) dockedStationDisplayName;
- (BOOL) dockedAtMainStation;
 
- (void) awardCommodityType:(NSString *)type amount:(OOCargoQuantity)amount;
 
- (void) resetScannerZoom;
 
- (OOGalaxyID) currentGalaxyID;
- (OOSystemID) currentSystemID;
 
- (void) setMissionChoice:(NSString *)newChoice;
- (void) setMissionChoice:(NSString *)newChoice withEvent:(BOOL) withEvent;
- (void) setMissionChoice:(NSString *)newChoice keyPress:(NSString *)keyPress;
- (void) setMissionChoice:(NSString *)newChoice keyPress:(NSString *)keyPress withEvent:(BOOL) withEvent;
- (void) allowMissionInterrupt;
 
- (OOTimeDelta) scriptTimer;
 
- (unsigned) systemPseudoRandom100;
- (unsigned) systemPseudoRandom256;
- (double) systemPseudoRandomFloat;
 
- (NSDictionary *) passengerContractMarker:(OOSystemID)system;
- (NSDictionary *) parcelContractMarker:(OOSystemID)system;
- (NSDictionary *) cargoContractMarker:(OOSystemID)system;
- (NSDictionary *) defaultMarker:(OOSystemID)system;
- (NSDictionary *) validatedMarker:(NSDictionary *)marker;
 
- (NSString *) keyBindingDescription2:(NSString *)binding;
- (NSString *) getKeyBindingDescription:(NSArray *)keyList;
- (NSString *) keyCodeDescription:(OOKeyCode)code;
- (NSString *) keyCodeDescriptionShort:(OOKeyCode)code;
 
- (NSString *) commanderKillsAsString;
- (NSString *) commanderBountyAsString;
- (NSString *) creditsFormattedForSubstitution;
- (NSString *) creditsFormattedForLegacySubstitution;
 
@end
 
 
/*  OOGalacticCoordinatesFromInternal()
    Given internal coordinates ranging from 0 to 255 on each axis, return
    corresponding coordinates in user-meaningful coordinates by scaling by
    0.4 on the X axis and 0.2 on the Y axis.
    
    OOInternalCoordinatesFromGalactic()
    Inverse operation.
    
    For valid floating-point comparisons, it is imperative that the same
    calculation be used consistently.
 */
Vector OOGalacticCoordinatesFromInternal(NSPoint internalCoordinates);
NSPoint OOInternalCoordinatesFromGalactic(Vector galacticCoordinates);