Entity.h File Reference

import "OOCocoa.h"
import "OOMaths.h"
import "OOCacheManager.h"
import "OOTypes.h"
import "OOWeakReference.h"
import "OOColor.h"
#include "OOEntityStatus.tbl"
#include "OOScanClass.tbl"

Include dependency graph for Entity.h:

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

Go to the source code of this file.

Classes
class	Entity
protocol	<OOBeaconEntity>

Macros
#define	NO_DRAW_DISTANCE_FACTOR   1024.0
#define	ABSOLUTE_NO_DRAW_DISTANCE2   (2500.0 * 2500.0 * NO_DRAW_DISTANCE_FACTOR * NO_DRAW_DISTANCE_FACTOR)
#define	SCANNER_MAX_RANGE   25600.0
#define	SCANNER_MAX_RANGE2   655360000.0
#define	CLOSE_COLLISION_CHECK_MAX_RANGE2   1000000000.0
#define	ENTRY(label, value)

Typedefs
typedef enum OOEntityStatus	OOEntityStatus
typedef enum OOScanClass	OOScanClass

Enumerations
enum	OOEntityStatus
enum	OOScanClass
enum	{ kOOEntityStatusDefault = STATUS_INACTIVE , kOOScanClassDefault = CLASS_NOT_SET }

Functions
NSString *	OOStringFromEntityStatus (OOEntityStatus status) CONST_FUNC
OOEntityStatus	OOEntityStatusFromString (NSString *string) PURE_FUNC
NSString *	OOStringFromScanClass (OOScanClass scanClass) CONST_FUNC
OOScanClass	OOScanClassFromString (NSString *string) PURE_FUNC

Variables
uint32_t	gLiveEntityCount
size_t	gTotalEntityMemory

Macro Definition Documentation

ABSOLUTE_NO_DRAW_DISTANCE2

#define ABSOLUTE_NO_DRAW_DISTANCE2   (2500.0 * 2500.0 * NO_DRAW_DISTANCE_FACTOR * NO_DRAW_DISTANCE_FACTOR)

Definition at line 47 of file Entity.h.

Referenced by Entity::isVisible.

CLOSE_COLLISION_CHECK_MAX_RANGE2

#define CLOSE_COLLISION_CHECK_MAX_RANGE2   1000000000.0

Definition at line 54 of file Entity.h.

ENTRY

#define ENTRY	(		label,
			value )

Value:

label = value,

Definition at line 57 of file Entity.h.

NO_DRAW_DISTANCE_FACTOR

#define NO_DRAW_DISTANCE_FACTOR   1024.0

Definition at line 46 of file Entity.h.

Referenced by OOMesh(Private)::calculateBoundingVolumes, OOLightParticleEntity::initWithDiameter:, OOVisualEffectEntity::setNoDrawDistance, OOSunEntity::setRadius:andCorona:, OOWaypointEntity::setSize:, ShipEntity::setUpSubEntities, and WormholeEntity::update:.

SCANNER_MAX_RANGE

#define SCANNER_MAX_RANGE   25600.0

Definition at line 51 of file Entity.h.

Referenced by Universe::addShipAt:withRole:withinRadius:, Universe::addShips:withRole:nearPosition:withCoordinateSystem:, Universe::addShipsToRoute:withRole:quantity:routeFraction:asGroup:, Universe::addShipWithRole:nearPosition:withCoordinateSystem:, ShipEntity::dealEnergyDamage:atRange:withBias:, WormholeEntity::disgorgeShips, DockEntity::dockingInstructionsForShip:, HeadUpDisplay(Private)::drawScanner:, HeadUpDisplay::drawScannerGrid, Universe::firstEntityTargetedByPlayer, Universe(OOPrivate)::fractionalPositionFrom:to:withFraction:, PlayerEntity::leaveWitchspace, ShipEntity::leaveWitchspace, Universe::locationByCode:withSun:andPlanet:, HeadUpDisplay::nonlinearScannerFunc, Universe(OOPrivate)::randomDistanceWithinScanner, PlayerEntity::setUpAndConfirmOK:saveGame:, PlayerEntity::setUpShipFromDictionary:, Universe::spawnShip:, SystemAddShipsOrGroup(), OOECMBlastEntity::update:, and PlayerEntity(OOPrivate)::updateAlertConditionForNearbyEntities.

SCANNER_MAX_RANGE2

#define SCANNER_MAX_RANGE2   655360000.0

Definition at line 52 of file Entity.h.

Referenced by ShipEntity::AuthorityPredicate, ShipEntity::becomeExplosion, ShipEntity::broadcastMessage:withUnpilotedOverride:, PlayerEntity(OOPrivate)::checkEntityForMassLock:withScanClass:, ShipEntity::checkForAegis, ShipEntity::checkShipsInVicinityForWitchJumpExit, PlayerEntity::doBookkeeping:, HeadUpDisplay(Private)::drawSecondaryTargetReticle:, ShipEntity(PureAI)::getWitchspaceEntryCoordinates, PlayerEntity(OOControlsPrivate)::handleAutopilotOn:, ShipEntity::initWithKey:definition:, PlayerEntity::isValidTarget:, Universe::locationByCode:withSun:andPlanet:, PlayerEntity::moveTargetMemoryBy:, DockEntity::pruneAndCountShipsOnApproach, ShipEntity(PureAI)::recallStoredTarget, ShipEntity(AI)::requestDockingCoordinates, ShipEntity::setTargetToNearestStationIncludingHostiles:, and PlayerEntity(OOPrivate)::updateAlertConditionForNearbyEntities.

Typedef Documentation

OOEntityStatus

typedef enum OOEntityStatus OOEntityStatus

OOScanClass

typedef enum OOScanClass OOScanClass

Definition at line 67 of file Entity.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kOOEntityStatusDefault
kOOScanClassDefault

Definition at line 322 of file Entity.h.

{
    // Values used for unknown strings.
    kOOEntityStatusDefault        = STATUS_INACTIVE,
    kOOScanClassDefault          = CLASS_NOT_SET
};

OOEntityStatus

enum OOEntityStatus

Definition at line 59 of file Entity.h.

{
    #include "OOEntityStatus.tbl"
} OOEntityStatus;

OOScanClass

enum OOScanClass

Definition at line 70 of file Entity.h.

{
    #include "OOScanClass.tbl"
};

Function Documentation

OOEntityStatusFromString()

OOEntityStatus OOEntityStatusFromString

(

NSString *

string

)

Definition at line 143 of file OOConstToString.m.

{
    #include "OOEntityStatus.tbl"
    
    return kOOEntityStatusDefault;
}

References kOOEntityStatusDefault.

OOScanClassFromString()

OOScanClass OOScanClassFromString

(

NSString *

string

)

Definition at line 183 of file OOConstToString.m.

{
    #include "OOScanClass.tbl"
    
    return kOOScanClassDefault;
}

References kOOScanClassDefault.

Referenced by ShipEntity::setUpShipFromDictionary:.

Here is the caller graph for this function:

OOStringFromEntityStatus()

NSString * OOStringFromEntityStatus

(

OOEntityStatus

status

)

Definition at line 41 of file OOConstToString.m.

{
    switch (value)
    {
        #include "OOEntityStatus.tbl"
    }
    return @"UNDEFINED";
}

Referenced by Entity::dumpSelfState, Entity(OOEntityInspectorExtensions)::inspStatusLine, PlayerEntity::isDocked, and PlayerEntity(Scripting)::status_string.

Here is the caller graph for this function:

OOStringFromScanClass()

NSString * OOStringFromScanClass

(

OOScanClass

scanClass

)

Definition at line 104 of file OOConstToString.m.

{
    switch (value)
    {
        #include "OOScanClass.tbl"
    }
    
    return @"UNDEFINED";
}

Referenced by Entity::dumpSelfState, and Entity(OOEntityInspectorExtensions)::inspScanClassLine.

Here is the caller graph for this function:

Variable Documentation

gLiveEntityCount

uint32_t gLiveEntityCount

extern

Definition at line 43 of file Entity.m.

Referenced by Entity::dealloc, and Entity::init.

gTotalEntityMemory

size_t gTotalEntityMemory

extern

Definition at line 44 of file Entity.m.

Referenced by Entity::dealloc, and Entity::init.