LevelUpHenchman(object, int, int)

Levels up a creature using the default settings.

int LevelUpHenchman(
    object oCreature,
    int nClass = CLASS_TYPE_INVALID,
    int bReadyAllSpells = FALSE
);

Parameters

oCreature

Creature to level up.

nClass

CLASS_TYPE_* (Default: CLASS_TYPE_INVALID)

bReadyAllSpells

Determines if all memorizable spell slots will be filled without requiring rest. (Default: FALSE)


Description

Levels up a creature using the default settings. Returns the new level if successful, or 0 if the function fails. You can assign a new class to level up in by specifying anything CLASS_TYPE_* constant other than CLASS_TYPE_INVALID (when CLASS_TYPE_INVALID is specified, the creature advances on an unknown default path). If an invalid class combination is chosen, like Barbarian and Paladin, the default class is levelled up.



Remarks

It is unknown which class is levelled up when a creature is already multiclassed.

It is unknown if more than three classes can be added to a creature with this function, or if the function errors.

I had problems getting this to work, so I imported Dorna from the original campaign into my test setting, and then it worked fine. I was able to level her up. However, if I changed her initial level from 1 to 10 manually in the toolset, I couldn’t level her up. It seems to me that for the LevelUpHenchman command to work, eg to level up Dorna from level 10 to 11 rogue, she needs to have all the feats, skills, etc granted to hear by the standard package for level 1-10. Leveling her up manually in the toolset doesn’t do that, which is probably why it wouldn’t work. If anyone can confirm that this is the way LevelUpHenchman works, please step forward :)


Version

1.30

See Also

categories: Henchmen/Familiars/Summoned Functions
constants: CLASS_TYPE_* Constants


 author: Charles Feduke, editor: Lilac Soul
 Send comments on this topic.