SetPhenoType

From NWN Lexicon
Jump to: navigation, search



SetPhenoType(int, object)

Sets the creature's PhenoType (body type) to the type specified.

void SetPhenoType(
    int nPhenoType,
    object oCreature = OBJECT_SELF
);

Parameters

nPhenoType

The creature's PhenoType (body type) to be changed to.

oCreature

The creature to change the PhenoType of. (Default: OBJECT_SELF)


Description

Sets the creature's PhenoType (body type) to the type specified.

nPhenoType has 3 valid values currently:

nPhenoType = PHENOTYPE_NORMAL
nPhenoType = PHENOTYPE_BIG
nPhenoType = PHENOTYPE_CUSTOM - The custom PhenoType should only ever be used if you have specifically created your own custom content that requires the use of a new PhenoType and you have specified the appropriate custom PhenoType in your custom content. SetPhenoType will only work on part based creature (i.e. the starting default playable races).



Remarks

Note that a phenotype is only valid for the default 7 PC races (Dwarf, Human, Half Elf, Half Orc, Elf, Gnome and Halfling).

It is basically the "Fat/Thin" option given when you create your character, however, custom content creators can have a better and more varied use for it as there will no doubt be.

Although 1.64 only supports an extra custom phenotype, there will certainly be up to 9 in total at one stage or another in a future patch.


Version

1.64

Example

// Sets the PC's phenotype, in a conversation (maybe some 
// growth-type one) to the big version.
 
void main()
{
    // Get the PC to change
    object oPC = GetPCSpeaker();
 
    // Set the phenotype
    SetPhenoType(PHENOTYPE_BIG, oPC);
}

See Also

functions: 

SetCreatureAppearanceType

constants: 

PHENOTYPE_* Constants



 author: Jasperre, additional contributor(s): Jasperre