OOCharacter Class Reference

#include <OOCharacter.h>

Inheritance diagram for OOCharacter:

Collaboration diagram for OOCharacter:

Instance Methods
(id)	- initWithRole:andOriginalSystem:
(NSString *)	- planetOfOrigin
(OOSystemID)	- planetIDOfOrigin
(NSString *)	- species
(void)	- basicSetUp
(BOOL)	- castInRole:
(NSString *)	- name
(void)	- setName:
(NSString *)	- shortDescription
(void)	- setShortDescription:
(int)	- legalStatus
(void)	- setLegalStatus:
(OOCreditsQuantity)	- insuranceCredits
(void)	- setInsuranceCredits:
(NSArray *)	- legacyScript
(void)	- setLegacyScript:
(OOJSScript *)	- script
(void)	- setCharacterScript:
(void)	- doScriptEvent:
(NSDictionary *)	- infoForScripting
(NSString *)	- descriptionComponents [implementation]
(NSString *)	- oo_jsClassName [implementation]
(void)	- dealloc [implementation]
(id)	- initWithGenSeed:andOriginalSystem: [implementation]
(Random_Seed)	- genSeed [implementation]
(void)	- setOriginSystem: [implementation]
(void)	- setGenSeed: [implementation]
(void)	- setCharacterFromDictionary: [implementation]

Class Methods
(OOCharacter *)	+ characterWithRole:andOriginalSystem:
(OOCharacter *)	+ randomCharacterWithRole:andOriginalSystem:
(OOCharacter *)	+ characterWithDictionary:

Private Attributes
NSString *	_name
NSString *	_shortDescription
OOSystemID	_originSystem
Random_Seed	_genSeed
int	_legalStatus
OOCreditsQuantity	_insuranceCredits
NSArray *	_scriptActions
OOJSScript *	_script

Detailed Description

Definition at line 35 of file OOCharacter.h.

Method Documentation

basicSetUp

- (void) basicSetUp

Definition at line 1 of file OOCharacter.m.

{   
    // save random seeds for restoration later
    RNG_Seed savedRNGSeed = currentRandomSeed();
    RANROTSeed savedRANROTSeed = RANROTGetFullSeed();
    // set RNG to character seed
    Random_Seed genSeed = [self genSeed];
    seed_for_planet_description(genSeed);
 
    // determine the planet of origin
    NSDictionary *originInfo = [UNIVERSE generateSystemData:[self planetIDOfOrigin]];
    NSString *planet = [originInfo oo_stringForKey:KEY_NAME];
    OOGovernmentID government = [originInfo oo_intForKey:KEY_GOVERNMENT]; // 0 .. 7 (0 anarchic .. 7 most stable)
    int criminalTendency = government ^ 0x07;
 
    // determine the character's species
    NSString *species = [self species];
    
    // determine the character's name
    seed_RNG_only_for_planet_description(genSeed);
    NSString *genName = nil;
    if ([species hasPrefix:@"human"])
    {
        genName = [NSString stringWithFormat:@"%@ %@", OOExpandWithSeed(genSeed, @"%R"), OOExpandKeyWithSeed(genSeed, @"nom")];
    } else {
        /*  NOTE: we can't use "%R %R" because that will produce the same string
            twice. TODO: is there a reason not to use %N and kOOExpandGoodRNG
            here? Is there some context where we rely on being able to get the
            same name for a given genSeed?
         */
        genName = [NSString stringWithFormat:@"%@ %@", OOExpandWithSeed(genSeed, @"%R"), OOExpandWithSeed(genSeed, @"%R")];
    }
    [self setName:genName];
    
    [self setShortDescription:OOExpandKeyWithSeed(genSeed, @"character-generic-description", species, planet)];
    
    // determine _legalStatus for a completely random character
    [self setLegalStatus:0];    // clean
    int legalIndex = gen_rnd_number() & gen_rnd_number() & 0x03;
    while (((gen_rnd_number() & 0xf) < criminalTendency) && (legalIndex < 3))
    {
        legalIndex++;
    }
    if (legalIndex == 3)
    {
        // criminal
        [self setLegalStatus:criminalTendency + criminalTendency * (gen_rnd_number() & 0x03) + (gen_rnd_number() & gen_rnd_number() & 0x7f)];
    }
    legalIndex = 0;
    if (_legalStatus > 0)  legalIndex = (_legalStatus <= 50) ? 1 : 2;
 
    // if clean - determine insurance level (if any)
    [self setInsuranceCredits:0];
    if (legalIndex == 0)
    {
        int insuranceIndex = gen_rnd_number() & gen_rnd_number() & 0x03;
        switch (insuranceIndex)
        {
            case 1:
                [self setInsuranceCredits:125];
                break;
            case 2:
                [self setInsuranceCredits:250];
                break;
            case 3:
                [self setInsuranceCredits:500];
        }
    }
    
    // restore random seed
    setRandomSeed( savedRNGSeed);
    RANROTSetFullSeed(savedRANROTSeed);
}

castInRole:

- (BOOL) castInRole:

(NSString *)

role

Definition at line 1 of file OOCharacter.m.

                   :(NSString *)role
{
    BOOL specialSetUpDone = NO;
    
    role = [role lowercaseString];
    if ([role hasPrefix:@"pirate"])
    {
        // determine _legalStatus for a completely random character
        Random_Seed genSeed = [self genSeed];
        int sins = 0x08 | (genSeed.a & genSeed.b);
        [self setLegalStatus:sins & 0x7f];
        
        specialSetUpDone = YES;
    }
    else if ([role hasPrefix:@"trader"])
    {
        [self setLegalStatus:0];    // clean
 
        int insuranceIndex = gen_rnd_number() & 0x03;
        switch (insuranceIndex)
        {
            case 0:
                [self setInsuranceCredits:0];
                break;
            case 1:
                [self setInsuranceCredits:125];
                break;
            case 2:
                [self setInsuranceCredits:250];
                break;
            case 3:
                [self setInsuranceCredits:500];
        }
        specialSetUpDone = YES;
    }
    else if ([role hasPrefix:@"hunter"])
    {
        [self setLegalStatus:0];    // clean
        int insuranceIndex = gen_rnd_number() & 0x03;
        if (insuranceIndex == 3)
            [self setInsuranceCredits:500];
        specialSetUpDone = YES;
    }
    else if ([role hasPrefix:@"police"])
    {
        [self setLegalStatus:0];    // clean
        [self setInsuranceCredits:125];
        specialSetUpDone = YES;
    }
    else if ([role isEqual:@"miner"])
    {
        [self setLegalStatus:0];    // clean
        [self setInsuranceCredits:25];
        specialSetUpDone = YES;
    }
    else if ([role isEqual:@"passenger"])
    {
        [self setLegalStatus:0];    // clean
        int insuranceIndex = gen_rnd_number() & 0x03;
        switch (insuranceIndex)
        {
            case 0:
                [self setInsuranceCredits:25];
                break;
            case 1:
                [self setInsuranceCredits:125];
                break;
            case 2:
                [self setInsuranceCredits:250];
                break;
            case 3:
                [self setInsuranceCredits:500];
        }
        specialSetUpDone = YES;
    }
    else if ([role isEqual:@"slave"])
    {
        [self setLegalStatus:0];    // clean
        [self setInsuranceCredits:0];
        specialSetUpDone = YES;
    }
    else if ([role isEqual:@"thargoid"])
    {
        [self setLegalStatus:100];
        [self setInsuranceCredits:0];
        [self setName:DESC(@"character-thargoid-name")];
        [self setShortDescription:DESC(@"character-a-thargoid")];
        specialSetUpDone = YES;
    }
    
    // do long description here
    
    return specialSetUpDone;
}

characterWithDictionary:

+ (OOCharacter *) characterWithDictionary:

(NSDictionary *)

c_dict

Definition at line 1 of file OOCharacter.m.

                                         :(NSDictionary *)dict
{
    OOCharacter *character = [[[OOCharacter alloc] init] autorelease];
    [character setCharacterFromDictionary:dict];
    
    return character;
}

Referenced by ShipSetCrew().

Here is the caller graph for this function:

characterWithRole:andOriginalSystem:

+ (OOCharacter *) characterWithRole:		(NSString *)	c_role
andOriginalSystem:		(OOSystemID)	s

Definition at line 1 of file OOCharacter.m.

                                   :(NSString *)role andOriginalSystem:(OOSystemID)system
{
    return [[[self alloc] initWithRole:role andOriginalSystem:system] autorelease];
}

dealloc

- (void) dealloc

implementation

Definition at line 1 of file OOCharacter.m.

{
    [_name release];
    [_shortDescription release];
    [_scriptActions release];
    DESTROY(_script);
    
    [super dealloc];
}

descriptionComponents

- (NSString *) descriptionComponents

implementation

Definition at line 1 of file OOCharacter.m.

{
    return [NSString stringWithFormat:@"%@, %@. bounty: %i insurance: %llu", [self name], [self shortDescription], [self legalStatus], [self insuranceCredits]];
}

doScriptEvent:

- (void) doScriptEvent:

(jsid)

message

Definition at line 1 of file OOCharacter.m.

                      :(jsid)message
{
    JSContext *context = OOJSAcquireContext();
    [_script callMethod:message inContext:context withArguments:NULL count:0 result:NULL];
    OOJSRelinquishContext(context);
}

genSeed

- (Random_Seed) genSeed

implementation

Provided by category OOCharacter(Private).

Definition at line 1 of file OOCharacter.m.

{
    return _genSeed;
}

infoForScripting

- (NSDictionary *) infoForScripting

Definition at line 1 of file OOCharacter.m.

{
    return [NSDictionary dictionaryWithObjectsAndKeys:
          [self name], @"name",
          [self shortDescription], @"description",
          [self species], @"species",
          [NSNumber numberWithInt:[self legalStatus]], @"legalStatus",
          [NSNumber numberWithUnsignedLongLong:[self insuranceCredits]], @"insuranceCredits",
          [NSNumber numberWithInt:[self planetIDOfOrigin]], @"homeSystem",
          nil];
}

initWithGenSeed:andOriginalSystem:

- (id) initWithGenSeed: (Random_Seed) characterSeed andOriginalSystem: (OOSystemID) system

implementation

Provided by category OOCharacter(Private).

Definition at line 1 of file OOCharacter.m.

                      :(Random_Seed)characterSeed andOriginalSystem:(OOSystemID)system
{
    if ((self = [super init]))
    {
        // do character set-up
        _genSeed = characterSeed;
        _originSystem = system;
        
        [self basicSetUp];
    }
    return self;
}

initWithRole:andOriginalSystem:

- (id) initWithRole:		(NSString *)	role
andOriginalSystem:		(OOSystemID)	s

Definition at line 1 of file OOCharacter.m.

                   :(NSString *)role andOriginalSystem:(OOSystemID)system
{
    Random_Seed seed;
    make_pseudo_random_seed(&seed);
    
    if ((self = [self initWithGenSeed:seed andOriginalSystem:system]))
    {
        [self castInRole:role];
    }
    
    return self;
}

insuranceCredits

- (OOCreditsQuantity) insuranceCredits

Definition at line 1 of file OOCharacter.m.

{
    return _insuranceCredits;
}

legacyScript

- (NSArray *) legacyScript

Definition at line 1 of file OOCharacter.m.

{
    return _scriptActions;
}

legalStatus

- (int) legalStatus

Definition at line 1 of file OOCharacter.m.

{
    return _legalStatus;
}

name

- (NSString *) name

Definition at line 1 of file OOCharacter.m.

{
    return _name;
}

oo_jsClassName

- (NSString *) oo_jsClassName

implementation

Definition at line 1 of file OOCharacter.m.

{
    return @"Character";
}

planetIDOfOrigin

- (OOSystemID) planetIDOfOrigin

Definition at line 1 of file OOCharacter.m.

{
    // determine the planet of origin
    return _originSystem;
}

planetOfOrigin

- (NSString *) planetOfOrigin

Definition at line 1 of file OOCharacter.m.

{
    // determine the planet of origin
    NSDictionary *originInfo = [UNIVERSE generateSystemData:[self planetIDOfOrigin]];
    return [originInfo objectForKey:KEY_NAME];
}

randomCharacterWithRole:andOriginalSystem:

+ (OOCharacter *) randomCharacterWithRole:		(NSString *)	c_role
andOriginalSystem:		(OOSystemID)	s

Definition at line 1 of file OOCharacter.m.

                                         :(NSString *)role andOriginalSystem:(OOSystemID)system
{
    Random_Seed seed;
    
    seed.a = (Ranrot() & 0xff);
    seed.b = (Ranrot() & 0xff);
    seed.c = (Ranrot() & 0xff);
    seed.d = (Ranrot() & 0xff);
    seed.e = (Ranrot() & 0xff);
    seed.f = (Ranrot() & 0xff);
    
    OOCharacter *character = [[[OOCharacter alloc] initWithGenSeed:seed andOriginalSystem:system] autorelease];
    [character castInRole:role];
    
    return character;
}

script

- (OOJSScript *) script

Definition at line 1 of file OOCharacter.m.

{
    return _script;
}

setCharacterFromDictionary:

- (void) setCharacterFromDictionary: (NSDictionary *) dict

implementation

Provided by category OOCharacter(Private).

Definition at line 1 of file OOCharacter.m.

                                   :(NSDictionary *)dict
{
    id                  origin = nil;
    Random_Seed         seed;
    
    origin = [dict objectForKey:@"origin"];
    if ([origin isKindOfClass:[NSNumber class]] ||
        ([origin respondsToSelector:@selector(intValue)] && ([origin intValue] != 0 || [origin isEqual:@"0"])))
    {
        // Number or numerical string
        [self setOriginSystem:[origin intValue]];
    }
    else if ([origin isKindOfClass:[NSString class]])
    {
        OOSystemID sys = [UNIVERSE findSystemFromName:origin];
        if (sys < 0)
        {
            OOLogERR(@"character.load.unknownSystem", @"could not find a system named '%@' in this galaxy.", origin);
            [self setOriginSystem:(ranrot_rand() & 0xff)];
        }
        else
        {
            [self setOriginSystem:sys];
        }
    }
    else
    {
        // no origin defined, select one at random.
        [self setOriginSystem:(ranrot_rand() & 0xff)];
    }
 
    if ([dict objectForKey:@"random_seed"])
    {
        seed = RandomSeedFromString([dict oo_stringForKey:@"random_seed"]);  // returns kNilRandomSeed on failure
    }
    else
    {
        seed.a = (ranrot_rand() & 0xff);
        seed.b = (ranrot_rand() & 0xff);
        seed.c = (ranrot_rand() & 0xff);
        seed.d = (ranrot_rand() & 0xff);
        seed.e = (ranrot_rand() & 0xff);
        seed.f = (ranrot_rand() & 0xff);
    }
    [self setGenSeed:seed];
    [self basicSetUp];
    
    if ([dict oo_stringForKey:@"role"])  [self castInRole:[dict oo_stringForKey:@"role"]];
    if ([dict oo_stringForKey:@"name"])  [self setName:[dict oo_stringForKey:@"name"]];
    if ([dict oo_stringForKey:@"short_description"])  [self setShortDescription:[dict oo_stringForKey:@"short_description"]];
    if ([dict objectForKey:@"legal_status"])  [self setLegalStatus:[dict oo_intForKey:@"legal_status"]];
    if ([dict objectForKey:@"bounty"])  [self setLegalStatus:[dict oo_intForKey:@"bounty"]];
    if ([dict objectForKey:@"insurance"])  [self setInsuranceCredits:[dict oo_unsignedLongLongForKey:@"insurance"]];
    if ([dict oo_stringForKey:@"script"]) [self setCharacterScript:[dict oo_stringForKey:@"script"]];
    if ([dict oo_arrayForKey:@"script_actions"])  [self setLegacyScript:[dict oo_arrayForKey:@"script_actions"]];
    
}

setCharacterScript:

- (void) setCharacterScript:

(NSString *)

scriptName

Definition at line 1 of file OOCharacter.m.

                           :(NSString *)scriptName
{
    [_script autorelease];
    _script = [OOScript jsScriptFromFileNamed:scriptName
                                   properties:[NSDictionary dictionaryWithObject:self forKey:@"character"]];
    [_script retain];
}

setGenSeed:

- (void) setGenSeed: (Random_Seed) value

implementation

Definition at line 1 of file OOCharacter.m.

                  :(Random_Seed)value
{
    _genSeed = value;
}

setInsuranceCredits:

- (void) setInsuranceCredits:

(OOCreditsQuantity)

value

Definition at line 1 of file OOCharacter.m.

                           :(OOCreditsQuantity)value
{
    _insuranceCredits = value;
}

setLegacyScript:

- (void) setLegacyScript:

(NSArray *)

scriptActions

Definition at line 1 of file OOCharacter.m.

                       :(NSArray *)some_actions
{
    [_scriptActions autorelease];
    _scriptActions = [some_actions copy];
}

setLegalStatus:

- (void) setLegalStatus:

(int)

value

Definition at line 1 of file OOCharacter.m.

                      :(int)value
{
    _legalStatus = value;
}

setName:

- (void) setName:

(NSString *)

value

Definition at line 1 of file OOCharacter.m.

               :(NSString *)value
{
    [_name autorelease];
    _name = [value copy];
}

setOriginSystem:

- (void) setOriginSystem: (OOSystemID) value

implementation

Provided by category OOCharacter(Private).

Definition at line 1 of file OOCharacter.m.

                       :(OOSystemID)value
{
    _originSystem = value;
}

setShortDescription:

- (void) setShortDescription:

(NSString *)

value

Definition at line 1 of file OOCharacter.m.

                           :(NSString *)value
{
    [_shortDescription autorelease];
    _shortDescription = [value copy];
}

shortDescription

- (NSString *) shortDescription

Definition at line 1 of file OOCharacter.m.

{
    return _shortDescription;
}

species

- (NSString *) species

Definition at line 1 of file OOCharacter.m.

{
    // determine the character's species
    int species = [self genSeed].f & 0x03;  // 0-1 native to home system, 2 human colonial, 3 other
    NSString* speciesString = nil;
    if (species == 3)  speciesString = [UNIVERSE getSystemInhabitants:[self genSeed].e plural:NO];
    else  speciesString = [UNIVERSE getSystemInhabitants:[self planetIDOfOrigin] plural:NO];
    
    if (![[UNIVERSE descriptions] oo_boolForKey:@"lowercase_ignore"])
    {
        speciesString = [speciesString lowercaseString];
    }
    
    return [speciesString stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
}

Member Data Documentation

_genSeed

- (Random_Seed) _genSeed

private

Definition at line 41 of file OOCharacter.h.

_insuranceCredits

- (OOCreditsQuantity) _insuranceCredits

private

Definition at line 43 of file OOCharacter.h.

_legalStatus

- (int) _legalStatus

private

Definition at line 42 of file OOCharacter.h.

_name

- (NSString*) _name

private

Definition at line 38 of file OOCharacter.h.

_originSystem

- (OOSystemID) _originSystem

private

Definition at line 40 of file OOCharacter.h.

_script

- (OOJSScript*) _script

private

Definition at line 45 of file OOCharacter.h.

_scriptActions

- (NSArray*) _scriptActions

private

Definition at line 44 of file OOCharacter.h.

_shortDescription

- (NSString*) _shortDescription

private

Definition at line 39 of file OOCharacter.h.

---

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

• src/Core/OOCharacter.h
• src/Core/OOCharacter.m