OOTypes.h File Reference

#include "OOFunctionAttributes.h"
#include "OOCocoa.h"
#include "OOViewID.tbl"
#include "OOLongRangeChartMode.tbl"
#include "OOCompassMode.tbl"
#include "OOLegalStatusReason.tbl"

Include dependency graph for OOTypes.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	ENTRY(label, value)
#define	ENTRY(label, value)
#define	DIFF_STRING_ENTRY(label, string)
#define	kOOMaxCredits   ULLONG_MAX
#define	VALID_WEAPON_FACINGS   (WEAPON_FACING_NONE | WEAPON_FACING_FORWARD | WEAPON_FACING_AFT | WEAPON_FACING_PORT | WEAPON_FACING_STARBOARD)

Typedefs
typedef NSString *	OOCommodityType
typedef uint32_t	OOCargoQuantity
typedef int32_t	OOCargoQuantityDelta
typedef uint16_t	OOFuelQuantity
typedef uint64_t	OOCreditsQuantity
typedef uint16_t	OOKeyCode
typedef uint16_t	OOUniversalID
typedef NSUInteger	OOTechLevelID
typedef uint8_t	OOGovernmentID
typedef uint8_t	OOEconomyID
typedef uint8_t	OOGalaxyID
typedef int16_t	OOSystemID
typedef double	OOTimeAbsolute
typedef double	OOTimeDelta
typedef uint8_t	OOWeaponFacingSet

Enumerations
enum	OORouteType { OPTIMIZED_BY_NONE , OPTIMIZED_BY_JUMPS , OPTIMIZED_BY_TIME }
enum	OOViewID { kOOViewIDDefault = VIEW_NONE }
enum	OOLongRangeChartMode { kOOLongRangeChartModeDefault = OOLRC_MODE_UNKNOWN }
enum	OOAegisStatus { AEGIS_NONE , AEGIS_CLOSE_TO_ANY_PLANET , AEGIS_CLOSE_TO_MAIN_PLANET , AEGIS_IN_DOCKING_RANGE }
enum	OOCargoType {   CARGO_NOT_CARGO = -1 , CARGO_SLAVES = 3 , CARGO_ALLOY = 9 , CARGO_MINERALS = 12 ,   CARGO_THARGOID = 16 , CARGO_RANDOM = 100 , CARGO_SCRIPTED_ITEM = 200 , CARGO_CHARACTER = 300 }
enum	OOCargoFlag {   CARGO_FLAG_NONE = 400 , CARGO_FLAG_FULL_PLENTIFUL = 501 , CARGO_FLAG_FULL_SCARCE = 502 , CARGO_FLAG_FULL_MEDICAL = 503 ,   CARGO_FLAG_FULL_CONTRABAND = 504 , CARGO_FLAG_PIRATE = 505 , CARGO_FLAG_FULL_UNIFORM = 510 , CARGO_FLAG_CANISTERS = 600 ,   CARGO_FLAG_FULL_PASSENGERS = 700 }
enum	OOMassUnit { UNITS_TONS , UNITS_KILOGRAMS , UNITS_GRAMS }
enum	OOEnergyUnitType {   ENERGY_UNIT_NONE , ENERGY_UNIT_NORMAL_DAMAGED , ENERGY_UNIT_NAVAL_DAMAGED , OLD_ENERGY_UNIT_NORMAL =15 ,   OLD_ENERGY_UNIT_NAVAL = 20 , ENERGY_UNIT_NORMAL = 8 , ENERGY_UNIT_NAVAL = 16 }
enum	OOCompassMode
enum	{ kOOCompassModeDefault = COMPASS_MODE_BASIC }
enum	OOLegalStatusReason { kOOLegalStatusReasonDefault = kOOLegalStatusReasonUnknown }
enum	OODockingClearanceStatus {   DOCKING_CLEARANCE_STATUS_NONE , DOCKING_CLEARANCE_STATUS_NOT_REQUIRED , DOCKING_CLEARANCE_STATUS_REQUESTED , DOCKING_CLEARANCE_STATUS_GRANTED ,   DOCKING_CLEARANCE_STATUS_TIMING_OUT }
enum	{ UNIVERSE_MAX_ENTITIES = 2048 , NO_TARGET = 0 , MIN_ENTITY_UID = 100 , MAX_ENTITY_UID = MIN_ENTITY_UID + UNIVERSE_MAX_ENTITIES + 1 }
enum	{ kOOVariableTechLevel = 99 }
enum	{ kOOMaximumGalaxyID = 7 , kOOMaximumSystemID = 255 , kOOMinimumSystemID = -1 , kOOSystemIDInterstellarSpace = kOOMinimumSystemID }
enum	OOWeaponFacing {   WEAPON_FACING_FORWARD = 1 , WEAPON_FACING_AFT = 2 , WEAPON_FACING_PORT = 4 , WEAPON_FACING_STARBOARD = 8 ,   WEAPON_FACING_NONE = 0 }
enum	OOGraphicsDetail {   DETAIL_LEVEL_MINIMUM = 0 , DETAIL_LEVEL_NORMAL = 1 , DETAIL_LEVEL_SHADERS = 2 , DETAIL_LEVEL_EXTRAS = 3 ,   DETAIL_LEVEL_MAXIMUM = 3 }

Macro Definition Documentation

DIFF_STRING_ENTRY

#define DIFF_STRING_ENTRY	(		label,
			string )

Value:

label,

Definition at line 158 of file OOTypes.h.

ENTRY [1/2]

#define ENTRY	(		label,
			value )

Value:

label,

Definition at line 40 of file OOTypes.h.

ENTRY [2/2]

#define ENTRY	(		label,
			value )

Value:

label = value,

Definition at line 40 of file OOTypes.h.

kOOMaxCredits

#define kOOMaxCredits   ULLONG_MAX

Definition at line 183 of file OOTypes.h.

Referenced by OODeciCreditsFromDouble().

VALID_WEAPON_FACINGS

#define VALID_WEAPON_FACINGS   (WEAPON_FACING_NONE | WEAPON_FACING_FORWARD | WEAPON_FACING_AFT | WEAPON_FACING_PORT | WEAPON_FACING_STARBOARD)

Definition at line 239 of file OOTypes.h.

Referenced by PlayerEntity::availableFacings, Universe::shipsForSaleForSystem:withTL:atTime:, and StationAddShipToShipyard().

Typedef Documentation

OOCargoQuantity

typedef uint32_t OOCargoQuantity

Definition at line 176 of file OOTypes.h.

OOCargoQuantityDelta

typedef int32_t OOCargoQuantityDelta

Definition at line 177 of file OOTypes.h.

OOCommodityType

typedef NSString* OOCommodityType

Definition at line 106 of file OOTypes.h.

OOCreditsQuantity

typedef uint64_t OOCreditsQuantity

Definition at line 182 of file OOTypes.h.

OOEconomyID

typedef uint8_t OOEconomyID

Definition at line 207 of file OOTypes.h.

OOFuelQuantity

typedef uint16_t OOFuelQuantity

Definition at line 179 of file OOTypes.h.

OOGalaxyID

typedef uint8_t OOGalaxyID

Definition at line 210 of file OOTypes.h.

OOGovernmentID

typedef uint8_t OOGovernmentID

Definition at line 206 of file OOTypes.h.

OOKeyCode

typedef uint16_t OOKeyCode

Definition at line 186 of file OOTypes.h.

OOSystemID

typedef int16_t OOSystemID

Definition at line 211 of file OOTypes.h.

OOTechLevelID

typedef NSUInteger OOTechLevelID

Definition at line 204 of file OOTypes.h.

OOTimeAbsolute

typedef double OOTimeAbsolute

Definition at line 223 of file OOTypes.h.

OOTimeDelta

typedef double OOTimeDelta

Definition at line 224 of file OOTypes.h.

OOUniversalID

typedef uint16_t OOUniversalID

Definition at line 189 of file OOTypes.h.

OOWeaponFacingSet

typedef uint8_t OOWeaponFacingSet

Definition at line 237 of file OOTypes.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
UNIVERSE_MAX_ENTITIES
NO_TARGET
MIN_ENTITY_UID
MAX_ENTITY_UID

Definition at line 191 of file OOTypes.h.

{
    UNIVERSE_MAX_ENTITIES  = 2048,
    NO_TARGET              = 0,
    MIN_ENTITY_UID            = 100,
    MAX_ENTITY_UID            = MIN_ENTITY_UID + UNIVERSE_MAX_ENTITIES + 1
};

anonymous enum

anonymous enum

Enumerator
kOOCompassModeDefault

Definition at line 149 of file OOTypes.h.

{
    kOOCompassModeDefault      = COMPASS_MODE_BASIC
};

anonymous enum

anonymous enum

Enumerator
kOOMaximumGalaxyID
kOOMaximumSystemID
kOOMinimumSystemID
kOOSystemIDInterstellarSpace

Definition at line 214 of file OOTypes.h.

{
    kOOMaximumGalaxyID                = 7,
    kOOMaximumSystemID                = 255,
    kOOMinimumSystemID                = -1,
    kOOSystemIDInterstellarSpace    = kOOMinimumSystemID
};

anonymous enum

anonymous enum

Enumerator
kOOVariableTechLevel

Definition at line 200 of file OOTypes.h.

{
    kOOVariableTechLevel    = 99
};

OOAegisStatus

enum OOAegisStatus

Enumerator
AEGIS_NONE
AEGIS_CLOSE_TO_ANY_PLANET
AEGIS_CLOSE_TO_MAIN_PLANET
AEGIS_IN_DOCKING_RANGE

Definition at line 59 of file OOTypes.h.

{
    AEGIS_NONE,
    AEGIS_CLOSE_TO_ANY_PLANET,
    AEGIS_CLOSE_TO_MAIN_PLANET,
    AEGIS_IN_DOCKING_RANGE
} OOAegisStatus;

OOCargoFlag

enum OOCargoFlag

Enumerator
CARGO_FLAG_NONE
CARGO_FLAG_FULL_PLENTIFUL
CARGO_FLAG_FULL_SCARCE
CARGO_FLAG_FULL_MEDICAL
CARGO_FLAG_FULL_CONTRABAND
CARGO_FLAG_PIRATE
CARGO_FLAG_FULL_UNIFORM
CARGO_FLAG_CANISTERS
CARGO_FLAG_FULL_PASSENGERS

Definition at line 108 of file OOTypes.h.

{
    CARGO_FLAG_NONE                  = 400,
    CARGO_FLAG_FULL_PLENTIFUL      = 501,
    CARGO_FLAG_FULL_SCARCE            = 502,
    CARGO_FLAG_FULL_MEDICAL              = 503,
    CARGO_FLAG_FULL_CONTRABAND                = 504,
    CARGO_FLAG_PIRATE              = 505,
    CARGO_FLAG_FULL_UNIFORM          = 510,
    CARGO_FLAG_CANISTERS            = 600,
    CARGO_FLAG_FULL_PASSENGERS        = 700
} OOCargoFlag;

OOCargoType

enum OOCargoType

Enumerator
CARGO_NOT_CARGO
CARGO_SLAVES
CARGO_ALLOY
CARGO_MINERALS
CARGO_THARGOID
CARGO_RANDOM
CARGO_SCRIPTED_ITEM
CARGO_CHARACTER

Definition at line 68 of file OOTypes.h.

{
    CARGO_NOT_CARGO                  = -1,
    CARGO_SLAVES                    = 3,
    CARGO_ALLOY                      = 9,
    CARGO_MINERALS                    = 12,
    CARGO_THARGOID                    = 16,
    CARGO_RANDOM                    = 100,
    CARGO_SCRIPTED_ITEM              = 200,
    CARGO_CHARACTER                  = 300
} OOCargoType;

OOCompassMode

enum OOCompassMode

Definition at line 144 of file OOTypes.h.

{
    #include "OOCompassMode.tbl"
} OOCompassMode;

OODockingClearanceStatus

enum OODockingClearanceStatus

Enumerator
DOCKING_CLEARANCE_STATUS_NONE
DOCKING_CLEARANCE_STATUS_NOT_REQUIRED
DOCKING_CLEARANCE_STATUS_REQUESTED
DOCKING_CLEARANCE_STATUS_GRANTED
DOCKING_CLEARANCE_STATUS_TIMING_OUT

Definition at line 166 of file OOTypes.h.

{
    DOCKING_CLEARANCE_STATUS_NONE,
    DOCKING_CLEARANCE_STATUS_NOT_REQUIRED,
    DOCKING_CLEARANCE_STATUS_REQUESTED,
    DOCKING_CLEARANCE_STATUS_GRANTED,
    DOCKING_CLEARANCE_STATUS_TIMING_OUT,
} OODockingClearanceStatus;

OOEnergyUnitType

enum OOEnergyUnitType

Enumerator
ENERGY_UNIT_NONE
ENERGY_UNIT_NORMAL_DAMAGED
ENERGY_UNIT_NAVAL_DAMAGED
OLD_ENERGY_UNIT_NORMAL
OLD_ENERGY_UNIT_NAVAL
ENERGY_UNIT_NORMAL
ENERGY_UNIT_NAVAL

Definition at line 130 of file OOTypes.h.

{
    ENERGY_UNIT_NONE,
    ENERGY_UNIT_NORMAL_DAMAGED,
    ENERGY_UNIT_NAVAL_DAMAGED,
    OLD_ENERGY_UNIT_NORMAL            =15,
    OLD_ENERGY_UNIT_NAVAL          = 20,
    ENERGY_UNIT_NORMAL                = 8,
    ENERGY_UNIT_NAVAL              = 16
} OOEnergyUnitType;

OOGraphicsDetail

enum OOGraphicsDetail

Enumerator
DETAIL_LEVEL_MINIMUM
DETAIL_LEVEL_NORMAL
DETAIL_LEVEL_SHADERS
DETAIL_LEVEL_EXTRAS
DETAIL_LEVEL_MAXIMUM

Definition at line 242 of file OOTypes.h.

{
    DETAIL_LEVEL_MINIMUM        = 0,
    DETAIL_LEVEL_NORMAL          = 1,
    DETAIL_LEVEL_SHADERS        = 2,
    DETAIL_LEVEL_EXTRAS          = 3,
 
 
 
    DETAIL_LEVEL_MAXIMUM        = 3
} OOGraphicsDetail;

OOLegalStatusReason

enum OOLegalStatusReason

Enumerator
kOOLegalStatusReasonDefault

Definition at line 156 of file OOTypes.h.

{
#define DIFF_STRING_ENTRY(label, string) label,
    #include "OOLegalStatusReason.tbl"
#undef DIFF_STRING_ENTRY
    
    kOOLegalStatusReasonDefault = kOOLegalStatusReasonUnknown
} OOLegalStatusReason;

OOLongRangeChartMode

enum OOLongRangeChartMode

Enumerator
kOOLongRangeChartModeDefault

Definition at line 49 of file OOTypes.h.

{
    #include "OOLongRangeChartMode.tbl"
 
    kOOLongRangeChartModeDefault = OOLRC_MODE_UNKNOWN
} OOLongRangeChartMode;

OOMassUnit

enum OOMassUnit

Enumerator
UNITS_TONS
UNITS_KILOGRAMS
UNITS_GRAMS

Definition at line 122 of file OOTypes.h.

{
    UNITS_TONS,
    UNITS_KILOGRAMS,
    UNITS_GRAMS
} OOMassUnit;

OORouteType

enum OORouteType

Enumerator
OPTIMIZED_BY_NONE
OPTIMIZED_BY_JUMPS
OPTIMIZED_BY_TIME

Definition at line 32 of file OOTypes.h.

{
    OPTIMIZED_BY_NONE,
    OPTIMIZED_BY_JUMPS,
    OPTIMIZED_BY_TIME
} OORouteType;

OOViewID

enum OOViewID

Enumerator
kOOViewIDDefault

Definition at line 42 of file OOTypes.h.

{
    #include "OOViewID.tbl"
        
    kOOViewIDDefault = VIEW_NONE
} OOViewID;

OOWeaponFacing

enum OOWeaponFacing

Enumerator
WEAPON_FACING_FORWARD
WEAPON_FACING_AFT
WEAPON_FACING_PORT
WEAPON_FACING_STARBOARD
WEAPON_FACING_NONE

Definition at line 227 of file OOTypes.h.

{
    WEAPON_FACING_FORWARD              = 1,
    WEAPON_FACING_AFT                  = 2,
    WEAPON_FACING_PORT                    = 4,
    WEAPON_FACING_STARBOARD              = 8,
    
    WEAPON_FACING_NONE                    = 0
} OOWeaponFacing;