ELC

Readme

An NWNX replacement for ValidateCharacter: ELC & ILR

Notes

If enabled and used without setting an ELC script it will function just like ELC/ILR in the base game.

This is a pretty advanced plugin and may at times require you to dive into the source code to figure out what's going on.

Environment Variables

Variable Name	Value	Default	Notes
NWNX_ELC_ELC_SCRIPT	string	""	Set the NWScript that receives all the ELC validation failure events.
NWNX_ELC_CUSTOM_ELC_CHECK	true/false	false	Enables the custom ELC check, an ELC script must be set for it to run.
NWNX_ELC_ENFORCE_DEFAULT_EVENT_SCRIPTS	true/false	false	If enabled, resets a character's event scripts to default. Requires ELC to be enabled.
NWNX_ELC_ENFORCE_EMPTY_DIALOG_RESREF	true/false	false	If enabled, resets a character's dialog resref to empty. Requires ELC to be enabled.
NWNX_ELC_ENFORCE_CASTER_PRIMARY_STAT_IS_11	true/false	false	If enabled, check when a character's first level class is a spellcaster, if their primary casting stat is >= 11.

Events

This plugin adds the following events which can be subscribed to with NWNX_Events.

NWNX_ON_ELC_VALIDATE_CHARACTER_BEFORE

NWNX_ON_ELC_VALIDATE_CHARACTER_AFTER

OBJECT_SELF is the player object, the _AFTER event only runs if the character successfully validates.

Example Script

#include "nwnx_elc"
 
void main()
{
    object oPC = OBJECT_SELF;
    int nType = NWNX_ELC_GetValidationFailureType();
    int nSubType = NWNX_ELC_GetValidationFailureSubType();
    int nStrRef = NWNX_ELC_GetValidationFailureMessageStrRef();
 
    WriteTimestampedLogEntry("ELC: FAIL: " + GetName(oPC) +
                        " -> Type = " +IntToString(nType) +
                        ", SubType = " +IntToString(nSubType) +
                        ", StrRef = " + IntToString(nStrRef));
 
    // MrMunchkin is friends with the server owner and gets to skip any ILR MinEquipLevel failures
    if (nSubType == NWNX_ELC_SUBTYPE_MIN_EQUIP_LEVEL)
    {
        if (GetPCPublicCDKey(oPC) == "OMG1337")
            NWNX_ELC_SkipValidationFailure();
    }
 
    // The validation failure happened on our current level so we could
    // just roll back their last level
    if (GetHitDice(oPC) == NWNX_ELC_GetValidationFailureLevel())
    {
        // Do XP Stuff here
        // Send message to player
        // Etc
        // NWNX_ELC_SkipValidationFailure();
        // return;
    }
 
    switch (nType)
    {
        case NWNX_ELC_VALIDATION_FAILURE_TYPE_CHARACTER:
        {
            // We allow colored names on our server
            if (nSubType == NWNX_ELC_SUBTYPE_COLORED_NAME)
            {
                NWNX_ELC_SkipValidationFailure();
            }
 
            break;
        }
 
        case NWNX_ELC_VALIDATION_FAILURE_TYPE_ITEM:
        {
            object oItem = NWNX_ELC_GetValidationFailureItem();
 
            // Unequip the item instead of having the player unable to login
            if (GetIsObjectValid(oItem))
                ActionUnequipItem(oItem);
 
            NWNX_ELC_SkipValidationFailure();
            break;
        }
 
        case NWNX_ELC_VALIDATION_FAILURE_TYPE_SKILL:
        {
            // We don't handle skill validation failures
            break;
        }
 
        case NWNX_ELC_VALIDATION_FAILURE_TYPE_FEAT:
        {
            // We ignore the ability requirement for the dodge feat
            if (nSubType == NWNX_ELC_SUBTYPE_FEAT_REQUIRED_ABILITY_VALUE_NOT_MET)
            {
                int nFeatID = NWNX_ELC_GetValidationFailureFeatID();
 
                if (nFeatID == FEAT_DODGE)
                {
                    NWNX_ELC_SkipValidationFailure();
                }
            }
            break;
        }
 
        case NWNX_ELC_VALIDATION_FAILURE_TYPE_SPELL:
        {
            // We skip all spell ELC checks
            NWNX_ELC_SkipValidationFailure();
            break;
        }
 
        // Enable with NWNX_ELC_EnableCustomELCCheck()
        case NWNX_ELC_VALIDATION_FAILURE_TYPE_CUSTOM:
        {
            // Only blue haired characters allowed on our server
            if (GetColor(oPC, COLOR_CHANNEL_HAIR) == 25)
            {
                NWNX_ELC_SkipValidationFailure();
            }
            else
            {
                // Set Custom Failure Message: Hair Color
                NWNX_ELC_SetValidationFailureMessageStrRef(125);
            }
            break;
        }
    }
}

Files
file	nwnx_elc.nss

Functions
void	NWNX_ELC_SetELCScript (string sScript)
	Sets the script that runs whenever an ELC validation failure happens. More...
void	NWNX_ELC_EnableCustomELCCheck (int bEnabled)
	Enables a custom ELC Check that will call the ELC Script with the NWNX_ELC_VALIDATION_FAILURE_TYPE_CUSTOM type. More...
void	NWNX_ELC_SkipValidationFailure ()
	Skip an ELC Validation Failure Event. More...
int	NWNX_ELC_GetValidationFailureType ()
	Get the validation failure type. More...
int	NWNX_ELC_GetValidationFailureSubType ()
	Get the validation failure subtype. More...
int	NWNX_ELC_GetValidationFailureMessageStrRef ()
	Get the failure message. More...
void	NWNX_ELC_SetValidationFailureMessageStrRef (int nStrRef)
	Set the failure message. More...
object	NWNX_ELC_GetValidationFailureItem ()
	Get the item that failed ILR validation. More...
int	NWNX_ELC_GetValidationFailureLevel ()
	Get the character level at which the validation failure occurred. More...
int	NWNX_ELC_GetValidationFailureSkillID ()
	Get the ID of the skill that failed ELC validation. More...
int	NWNX_ELC_GetValidationFailureFeatID ()
	Get the ID of the feat that failed ELC validation. More...
int	NWNX_ELC_GetValidationFailureSpellID ()
	Get the ID of the spell that failed ELC validation. More...

Function Documentation

NWNX_ELC_SetELCScript()

void NWNX_ELC_SetELCScript

(

string

sScript

)

Sets the script that runs whenever an ELC validation failure happens.

Parameters

sScript

The script name.

Definition at line 147 of file nwnx_elc.nss.

NWNX_ELC_EnableCustomELCCheck()

void NWNX_ELC_EnableCustomELCCheck

(

int

bEnabled

)

Enables a custom ELC Check that will call the ELC Script with the NWNX_ELC_VALIDATION_FAILURE_TYPE_CUSTOM type.

Parameters

bEnabled

TRUE to use this check.

Note

Only runs if you have an ELC script set, be sure to skip this check if a player doesn't fail your custom check otherwise they won't be able to log in

Definition at line 153 of file nwnx_elc.nss.

NWNX_ELC_SkipValidationFailure()

void NWNX_ELC_SkipValidationFailure

(

)

Skip an ELC Validation Failure Event.

Note

Only to be called in the ELC Script

Definition at line 159 of file nwnx_elc.nss.

NWNX_ELC_GetValidationFailureType()

int NWNX_ELC_GetValidationFailureType

(

)

Get the validation failure type.

Returns

A Validation Failure Type

Note

Only to be called in the ELC Script

Definition at line 164 of file nwnx_elc.nss.

NWNX_ELC_GetValidationFailureSubType()

int NWNX_ELC_GetValidationFailureSubType

(

)

Get the validation failure subtype.

Returns

A Validation Failure Subtype

Note

Only to be called in the ELC Script

Definition at line 170 of file nwnx_elc.nss.

NWNX_ELC_GetValidationFailureMessageStrRef()

int NWNX_ELC_GetValidationFailureMessageStrRef

(

)

Get the failure message.

Returns

The talk table strref the player receives.

Note

Only to be called in the ELC Script

Definition at line 176 of file nwnx_elc.nss.

NWNX_ELC_SetValidationFailureMessageStrRef()

void NWNX_ELC_SetValidationFailureMessageStrRef

(

int

nStrRef

)

Set the failure message.

Parameters

nStrRef

The talk table strref the player receives, must be > 0.

Note

Only to be called in the ELC Script

Definition at line 182 of file nwnx_elc.nss.

NWNX_ELC_GetValidationFailureItem()

object NWNX_ELC_GetValidationFailureItem

(

)

Get the item that failed ILR validation.

Returns

The object that caused the ILR validation failure. Returns OBJECT_INVALID on error.

Note

Only to be called in the ELC Script during a NWNX_ELC_VALIDATION_FAILURE_TYPE_ITEM validation failure.

Definition at line 188 of file nwnx_elc.nss.

NWNX_ELC_GetValidationFailureLevel()

int NWNX_ELC_GetValidationFailureLevel

(

)

Get the character level at which the validation failure occurred.

Returns

The character level or -1 on error.

Remarks

May not always return a level, depending on where the failure occurred.

Note

Only to be called in the ELC Script

Definition at line 194 of file nwnx_elc.nss.

NWNX_ELC_GetValidationFailureSkillID()

int NWNX_ELC_GetValidationFailureSkillID

(

)

Get the ID of the skill that failed ELC validation.

Returns

The skill ID or -1 on error.

Remarks

May not always return a skill id, depending on the validation failure subtype.

Note

Only to be called in the ELC Script during a NWNX_ELC_VALIDATION_FAILURE_TYPE_SKILL validation failure.

Definition at line 200 of file nwnx_elc.nss.

NWNX_ELC_GetValidationFailureFeatID()

int NWNX_ELC_GetValidationFailureFeatID

(

)

Get the ID of the feat that failed ELC validation.

Returns

The feat ID or -1 on error

Remarks

May not always return a feat id, depending on the validation failure subtype.

Note

Only to be called in the ELC Script during a NWNX_ELC_VALIDATION_FAILURE_TYPE_FEAT validation failure.

Definition at line 206 of file nwnx_elc.nss.

NWNX_ELC_GetValidationFailureSpellID()

int NWNX_ELC_GetValidationFailureSpellID

(

)

Get the ID of the spell that failed ELC validation.

Returns

The spell ID or -1 on error

Remarks

May not always return a spell id, depending on the validation failure subtype.

Note

Only to be called in the ELC Script during a NWNX_ELC_VALIDATION_FAILURE_TYPE_SPELL validation failure.

Definition at line 212 of file nwnx_elc.nss.

Variable Documentation

NWNX_ELC_VALIDATION_FAILURE_TYPE_NONE

const int NWNX_ELC_VALIDATION_FAILURE_TYPE_NONE = 0

Definition at line 12 of file nwnx_elc.nss.

NWNX_ELC_VALIDATION_FAILURE_TYPE_CHARACTER

const int NWNX_ELC_VALIDATION_FAILURE_TYPE_CHARACTER = 1

Definition at line 13 of file nwnx_elc.nss.

NWNX_ELC_VALIDATION_FAILURE_TYPE_ITEM

const int NWNX_ELC_VALIDATION_FAILURE_TYPE_ITEM = 2

Definition at line 14 of file nwnx_elc.nss.

NWNX_ELC_VALIDATION_FAILURE_TYPE_SKILL

const int NWNX_ELC_VALIDATION_FAILURE_TYPE_SKILL = 3

Definition at line 15 of file nwnx_elc.nss.

NWNX_ELC_VALIDATION_FAILURE_TYPE_FEAT

const int NWNX_ELC_VALIDATION_FAILURE_TYPE_FEAT = 4

Definition at line 16 of file nwnx_elc.nss.

NWNX_ELC_VALIDATION_FAILURE_TYPE_SPELL

const int NWNX_ELC_VALIDATION_FAILURE_TYPE_SPELL = 5

Definition at line 17 of file nwnx_elc.nss.

NWNX_ELC_VALIDATION_FAILURE_TYPE_CUSTOM

const int NWNX_ELC_VALIDATION_FAILURE_TYPE_CUSTOM = 6

Definition at line 18 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_NONE

const int NWNX_ELC_SUBTYPE_NONE = 0

Definition at line 24 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SERVER_LEVEL_RESTRICTION

const int NWNX_ELC_SUBTYPE_SERVER_LEVEL_RESTRICTION = 1

Definition at line 25 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_LEVEL_HACK

const int NWNX_ELC_SUBTYPE_LEVEL_HACK = 2

Definition at line 26 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_COLORED_NAME

const int NWNX_ELC_SUBTYPE_COLORED_NAME = 3

Definition at line 27 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_UNIDENTIFIED_EQUIPPED_ITEM

const int NWNX_ELC_SUBTYPE_UNIDENTIFIED_EQUIPPED_ITEM = 4

Definition at line 28 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_MIN_EQUIP_LEVEL

const int NWNX_ELC_SUBTYPE_MIN_EQUIP_LEVEL = 5

Definition at line 29 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_NON_PC_CHARACTER

const int NWNX_ELC_SUBTYPE_NON_PC_CHARACTER = 6

Definition at line 30 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_DM_CHARACTER

const int NWNX_ELC_SUBTYPE_DM_CHARACTER = 7

Definition at line 31 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_NON_PLAYER_RACE

const int NWNX_ELC_SUBTYPE_NON_PLAYER_RACE = 8

Definition at line 32 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_NON_PLAYER_CLASS

const int NWNX_ELC_SUBTYPE_NON_PLAYER_CLASS = 9

Definition at line 33 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_CLASS_LEVEL_RESTRICTION

const int NWNX_ELC_SUBTYPE_CLASS_LEVEL_RESTRICTION = 10

Definition at line 34 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_PRESTIGE_CLASS_REQUIREMENTS

const int NWNX_ELC_SUBTYPE_PRESTIGE_CLASS_REQUIREMENTS = 11

Definition at line 35 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_CLASS_ALIGNMENT_RESTRICTION

const int NWNX_ELC_SUBTYPE_CLASS_ALIGNMENT_RESTRICTION = 12

Definition at line 36 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_STARTING_ABILITY_VALUE_MAX

const int NWNX_ELC_SUBTYPE_STARTING_ABILITY_VALUE_MAX = 13

Definition at line 37 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_ABILITY_POINT_BUY_SYSTEM_CALCULATION

const int NWNX_ELC_SUBTYPE_ABILITY_POINT_BUY_SYSTEM_CALCULATION = 14

Definition at line 38 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_CLASS_SPELLCASTER_INVALID_PRIMARY_STAT

const int NWNX_ELC_SUBTYPE_CLASS_SPELLCASTER_INVALID_PRIMARY_STAT = 15

Definition at line 39 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_EPIC_LEVEL_FLAG

const int NWNX_ELC_SUBTYPE_EPIC_LEVEL_FLAG = 16

Definition at line 40 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_TOO_MANY_HITPOINTS

const int NWNX_ELC_SUBTYPE_TOO_MANY_HITPOINTS = 17

Definition at line 41 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_UNUSABLE_SKILL

const int NWNX_ELC_SUBTYPE_UNUSABLE_SKILL = 18

Definition at line 42 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_NOT_ENOUGH_SKILLPOINTS

const int NWNX_ELC_SUBTYPE_NOT_ENOUGH_SKILLPOINTS = 19

Definition at line 43 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_INVALID_NUM_RANKS_IN_CLASS_SKILL

const int NWNX_ELC_SUBTYPE_INVALID_NUM_RANKS_IN_CLASS_SKILL = 20

Definition at line 44 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_INVALID_NUM_RANKS_IN_NON_CLASS_SKILL

const int NWNX_ELC_SUBTYPE_INVALID_NUM_RANKS_IN_NON_CLASS_SKILL = 21

Definition at line 45 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_INVALID_NUM_REMAINING_SKILL_POINTS

const int NWNX_ELC_SUBTYPE_INVALID_NUM_REMAINING_SKILL_POINTS = 22

Definition at line 46 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_INVALID_FEAT

const int NWNX_ELC_SUBTYPE_INVALID_FEAT = 23

Definition at line 47 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_FEAT_REQUIRED_SPELL_LEVEL_NOT_MET

const int NWNX_ELC_SUBTYPE_FEAT_REQUIRED_SPELL_LEVEL_NOT_MET = 24

Definition at line 48 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_FEAT_REQUIRED_BASE_ATTACK_BONUS_NOT_MET

const int NWNX_ELC_SUBTYPE_FEAT_REQUIRED_BASE_ATTACK_BONUS_NOT_MET = 25

Definition at line 49 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_FEAT_REQUIRED_ABILITY_VALUE_NOT_MET

const int NWNX_ELC_SUBTYPE_FEAT_REQUIRED_ABILITY_VALUE_NOT_MET = 26

Definition at line 50 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_FEAT_REQUIRED_SKILL_NOT_MET

const int NWNX_ELC_SUBTYPE_FEAT_REQUIRED_SKILL_NOT_MET = 27

Definition at line 51 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_FEAT_REQUIRED_FEAT_NOT_MET

const int NWNX_ELC_SUBTYPE_FEAT_REQUIRED_FEAT_NOT_MET = 28

Definition at line 52 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_TOO_MANY_FEATS_THIS_LEVEL

const int NWNX_ELC_SUBTYPE_TOO_MANY_FEATS_THIS_LEVEL = 29

Definition at line 53 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_FEAT_NOT_AVAILABLE_TO_CLASS

const int NWNX_ELC_SUBTYPE_FEAT_NOT_AVAILABLE_TO_CLASS = 30

Definition at line 54 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_FEAT_IS_NORMAL_FEAT_ONLY

const int NWNX_ELC_SUBTYPE_FEAT_IS_NORMAL_FEAT_ONLY = 31

Definition at line 55 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_FEAT_IS_BONUS_FEAT_ONLY

const int NWNX_ELC_SUBTYPE_FEAT_IS_BONUS_FEAT_ONLY = 32

Definition at line 56 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SPELL_INVALID_SPELL_GAIN_WIZARD

const int NWNX_ELC_SUBTYPE_SPELL_INVALID_SPELL_GAIN_WIZARD = 33

Definition at line 57 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SPELL_INVALID_SPELL_GAIN_BARD_SORCERER

const int NWNX_ELC_SUBTYPE_SPELL_INVALID_SPELL_GAIN_BARD_SORCERER = 34

Definition at line 58 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SPELL_INVALID_SPELL_GAIN_OTHER_CLASSES

const int NWNX_ELC_SUBTYPE_SPELL_INVALID_SPELL_GAIN_OTHER_CLASSES = 35

Definition at line 59 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_INVALID_SPELL

const int NWNX_ELC_SUBTYPE_INVALID_SPELL = 36

Definition at line 60 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SPELL_INVALID_SPELL_LEVEL

const int NWNX_ELC_SUBTYPE_SPELL_INVALID_SPELL_LEVEL = 37

Definition at line 61 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SPELL_MINIMUM_ABILITY

const int NWNX_ELC_SUBTYPE_SPELL_MINIMUM_ABILITY = 40

Definition at line 62 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SPELL_RESTRICTED_SPELL_SCHOOL

const int NWNX_ELC_SUBTYPE_SPELL_RESTRICTED_SPELL_SCHOOL = 41

Definition at line 63 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SPELL_ALREADY_KNOWN

const int NWNX_ELC_SUBTYPE_SPELL_ALREADY_KNOWN = 42

Definition at line 64 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SPELL_WIZARD_EXCEEDS_NUMSPELLS_TO_ADD

const int NWNX_ELC_SUBTYPE_SPELL_WIZARD_EXCEEDS_NUMSPELLS_TO_ADD = 43

Definition at line 65 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_ILLEGAL_REMOVED_SPELL

const int NWNX_ELC_SUBTYPE_ILLEGAL_REMOVED_SPELL = 44

Definition at line 66 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_REMOVED_NOT_KNOWN_SPELL

const int NWNX_ELC_SUBTYPE_REMOVED_NOT_KNOWN_SPELL = 45

Definition at line 67 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_INVALID_NUM_SPELLS

const int NWNX_ELC_SUBTYPE_INVALID_NUM_SPELLS = 46

Definition at line 68 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SPELL_LIST_COMPARISON

const int NWNX_ELC_SUBTYPE_SPELL_LIST_COMPARISON = 47

Definition at line 69 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_SKILL_LIST_COMPARISON

const int NWNX_ELC_SUBTYPE_SKILL_LIST_COMPARISON = 48

Definition at line 70 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_FEAT_LIST_COMPARISON

const int NWNX_ELC_SUBTYPE_FEAT_LIST_COMPARISON = 49

Definition at line 71 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_MISC_SAVING_THROW

const int NWNX_ELC_SUBTYPE_MISC_SAVING_THROW = 50

Definition at line 72 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_NUM_FEAT_COMPARISON

const int NWNX_ELC_SUBTYPE_NUM_FEAT_COMPARISON = 51

Definition at line 73 of file nwnx_elc.nss.

NWNX_ELC_SUBTYPE_NUM_MULTICLASS

const int NWNX_ELC_SUBTYPE_NUM_MULTICLASS = 52

Definition at line 74 of file nwnx_elc.nss.