Skins: |

NWN2 SCRIPTS

- Jump to comments -

Name

Configuring a character-specific module

Author

Bob Hall

Submitted / Updated

07-27-2010 / 07-27-2010

Category

Scripting routines

Type

Type - Other

Format

Code Only

ShowCode

// endgame_if_wrong_pc
/*
    Creature comparison functions.
    
    The endgame_if_wrong_pc routine can be run at the start of a
    module that is designed for a specific player character (rather
    than a character that was generated by the player). It compares
    the properties of the PC against those of a creature prototype
    blueprint in the module. This prototype blueprint should be
    configured to match the character that the player will be
    loading, and it should have the "Script Hidden" property set to
    False. On a failure, a message dialog is printed. When the "Exit"
    button is selected, the EXIT_SCRIPT script is run.
*/
// RJH 07/09/10

// ************************
// *** Constants
// ************************

const string CAMPAIGN_CHECK_PC	= "CAMPAIGN_CHECK_PC";
const string PC_PROTOTYPE_TAG	= "pc_prototype_tag";
const string EXIT_CBSCRIPT      = "gui_exit_to_menu";
const string EXIT_BUTTON        = "Exit";
const string CONTINUE_BUTTON    = "Continue";

// ************************
// *** Prototypes
// ************************

int is_race_match( object oPC, object oTC );
int is_gender_match( object oPC, object oTC );
int is_ability_match( object oPC, object oTC, int nAbility );
int is_class_level_match( object oPC, object oTC, int nPosition );
int is_name_match( object oPC, object oTC );
int is_hit_points_match( object oPC, object oTC );
int is_alignment_match( object oPC, object oTC );
int is_alignment_match( object oPC, object oTC );
int is_skills_match( object oPC, object oTC );
int is_pc_match( object oPC, object oTC );
int is_deity_match( object oPC, object oTC );
int is_feat_match( object oPC, object oTC, int nFeat );
int is_domain_feats_match( object oPC, object oTC );
int is_background_feat_match( object oPC, object oTC );
int is_prestige_feats_match( object oPC, object oTC );

void endgame_if_wrong_pc( string sResref, string sExitMsg, int isTestOnly );

// ************************
// *** Functions
// ************************

// Return true only if the race and subrace match
int is_race_match( object oPC, object oTC )
{
  if ( GetRacialType( oPC ) != GetRacialType( oTC ) ) return FALSE;
  return ( GetSubRace( oPC ) == GetSubRace( oTC ) );
}

// Return true only if the gender matches
int is_gender_match( object oPC, object oTC )
{
  return ( GetGender( oPC ) == GetGender( oTC ) );
}

// Return true only if all the ability scores match
int is_abilities_match( object oPC, object oTC )
{
  int n;
  
  for ( n = ABILITY_STRENGTH; n <= ABILITY_CHARISMA; n++ ) {
    int pcAbility = GetAbilityScore( oPC, n );
    int tcAbility = GetAbilityScore( oTC, n );
	if ( pcAbility != tcAbility ) return FALSE;
  }
  return TRUE;
}

// Return true only if the class and level match
int is_class_levels_match( object oPC, object oTC )
{
  int n;
  
  for ( n = 1; n <= 3; n++ ) {
    // Compare class at this position
    int pcClass = GetClassByPosition( n, oPC );
    int tcClass = GetClassByPosition( n, oTC );
    if ( pcClass != tcClass ) return FALSE;
    
	// Compare levels if the class is valid
	if ( pcClass != CLASS_TYPE_INVALID ) {
      int pcLevel = GetLevelByClass( pcClass, oPC );
      int tcLevel = GetLevelByClass( tcClass, oPC );
	  if ( pcLevel != tcLevel ) return FALSE;
    }
  }
  
  return TRUE;
}

// Return true only if the full names match
int is_name_match( object oPC, object oTC )
{
  string pcName = GetFirstName( oPC );
  string tcName = GetFirstName( oTC );
  if ( pcName != tcName ) return FALSE;
  
  pcName = GetLastName( oPC );
  tcName = GetLastName( oTC );
  return ( pcName == tcName );
}

// Return true only if the maximum hit points match
int is_hit_points_match( object oPC, object oTC )
{
  return ( GetMaxHitPoints( oPC ) == GetMaxHitPoints( oTC ) );
}

// Return true only if the alignments match
int is_alignment_match( object oPC, object oTC )
{
  int pcAlign = GetAlignmentGoodEvil( oPC );
  int tcAlign = GetAlignmentGoodEvil( oTC );
  if ( pcAlign != tcAlign ) return FALSE;
  
  pcAlign = GetAlignmentLawChaos( oPC );
  tcAlign = GetAlignmentLawChaos( oTC );
  return ( pcAlign == tcAlign );
}

// Return true if all skill ranks match
int is_skills_match( object oPC, object oTC )
{
  int n;
  
  for ( n = SKILL_CONCENTRATION; n <= SKILL_SURVIVAL; n++ ) {
    if ( n == 2 ) continue; // Deleted skill
    int pcSkillRank = GetSkillRank( n, oPC, TRUE );
	int tcSkillRank = GetSkillRank( n, oTC, TRUE );
	if ( pcSkillRank != tcSkillRank ) return FALSE;
  }
  return TRUE;
}

// Return true if the deity strings match
int is_deity_match( object oPC, object oTC )
{
  return ( GetDeity( oPC ) == GetDeity( oTC ) );
}

// Return true if the feat matches
int is_feat_match( object oPC, object oTC, int nFeat )
{
  int bPCHasFeat = GetHasFeat( nFeat, oPC, TRUE );
  int bTCHasFeat = GetHasFeat( nFeat, oTC, TRUE );
  return ( bPCHasFeat == bTCHasFeat );
}

// Return true if the domain feats match
int is_domain_feats_match( object oPC, object oTC )
{
  int n;
  
  for ( n = FEAT_WAR_DOMAIN_POWER; n <= FEAT_WATER_DOMAIN_POWER; n++ )
    if ( ! is_feat_match( oPC, oTC, n ) )
	  return FALSE;
  return TRUE;
}

// Return true if the background feat matches
int is_background_feat_match( object oPC, object oTC )
{
  int n;
  
  for ( n = FEAT_BACKGROUND_BULLY; n <= FEAT_BACKGROUND_WIZARDS_APPRENTICE; n++ )
    if ( ! is_feat_match( oPC, oTC, n ) )
	  return FALSE;
  return TRUE;
}

// Return true if the required prestige class feats match
int is_prestige_feats_match( object oPC, object oTC )
{
  int n;
  
  if ( ! is_feat_match( oPC, oTC, FEAT_ALERTNESS ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_CLEAVE ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_COMBAT_CASTING ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_COMBAT_EXPERTISE ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_DODGE ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_FEINT ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_GREAT_CLEAVE ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_GREAT_FORTITUDE ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_GREATER_SPELL_PENETRATION ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_IMPROVED_UNARMED_STRIKE ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_IRON_WILL ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_MOBILITY ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_POINT_BLANK_SHOT ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_POWER_ATTACK ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_SKILL_FOCUS_CONCENTRATION ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_SKILL_FOCUS_SPELLCRAFT ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_SPELL_PENETRATION ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_SPRING_ATTACK ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_STEALTHY ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_STUNNING_FIST ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_TOUGHNESS ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_TWO_WEAPON_FIGHTING ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_WEAPON_FINESSE ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_WHIRLWIND_ATTACK ) ) return FALSE;
  
  if ( ! is_feat_match( oPC, oTC, FEAT_EMPOWER_SPELL ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_EXTEND_SPELL ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_MAXIMIZE_SPELL ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_QUICKEN_SPELL ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_SILENCE_SPELL ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_STILL_SPELL ) ) return FALSE;
  
  if ( ! is_feat_match( oPC, oTC, FEAT_BREW_POTION ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_CRAFT_MAGIC_ARMS_AND_ARMOR ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_CRAFT_WAND ) ) return FALSE;
  if ( ! is_feat_match( oPC, oTC, FEAT_CRAFT_WONDROUS_ITEMS ) ) return FALSE;
  
  for ( n = FEAT_WEAPON_FOCUS_DAGGER; n <= FEAT_WEAPON_FOCUS_TWO_BLADED_SWORD; n++ ) {
    if ( n == 119 ) continue;
	if ( n == 124 ) continue;
    if ( ! is_feat_match( oPC, oTC, n ) ) return FALSE;
  }
  
  return TRUE;
}

// Return true only if all the properties match
int is_pc_match( object oPC, object oTC )
{
  // Compare the properties between the player character oPC
  // and the template character oTC. If any of the properties
  // don't match, return false.
  if ( ! is_name_match( oPC, oTC ) ) return FALSE;
  if ( ! is_race_match( oPC, oTC ) ) return FALSE;
  if ( ! is_gender_match( oPC, oTC ) ) return FALSE;
  if ( ! is_abilities_match( oPC, oTC ) ) return FALSE;
  if ( ! is_class_levels_match( oPC, oTC ) ) return FALSE;
  if ( ! is_hit_points_match( oPC, oTC ) ) return FALSE;
  if ( ! is_alignment_match( oPC, oTC ) ) return FALSE;
  if ( ! is_skills_match( oPC, oTC ) ) return FALSE;
  if ( ! is_deity_match( oPC, oTC ) ) return FALSE;
  if ( ! is_domain_feats_match( oPC, oTC ) ) return FALSE;
  if ( ! is_background_feat_match( oPC, oTC ) ) return FALSE;
  if ( ! is_prestige_feats_match( oPC, oTC ) ) return FALSE;
  
  return TRUE;
}

/*  Create a creature object using the template resource reference
 *  with the name sResref. If successful, compare the properties to
 *  the player's character. If any of properties don't match, display
 *  a message with the string sExitMsg in a dialog box. On clicking
 *  okay, run the EXIT_SCRIPT script. If bAllowContinue is set to
 *  true, include a continue button to allow player to proceed.
 *
 *    sResName       = Resource name of the prototype.
 *	  sExitMsg       = Message to print prior to exit.
 *    bAllowContinue = If true, allow option to continue.
 */
void endgame_if_wrong_pc( string sResName, string sExitMsg, int bAllowContinue = FALSE )
{
  // Only run once for entire campaign
  if ( GetGlobalInt( CAMPAIGN_CHECK_PC ) == FALSE )
  {
    SetGlobalInt( CAMPAIGN_CHECK_PC, TRUE );
    
    // Create a copy of the template creature
    object oPC = GetFirstPC( TRUE );
    location locAt = GetLocation( oPC );
    object oTC = CreateObject( OBJECT_TYPE_CREATURE,
      sResName, locAt, FALSE, PC_PROTOTYPE_TAG );
    if ( ! GetIsObjectValid( oTC ) ) return;
    
    // Check if the PC does not match the template
    if ( ! is_pc_match( oPC, oTC ) ) {
	  DisplayMessageBox(
	  	oPC,            // Display a message box for this PC
		-1,             // String ref to display
		sExitMsg,       // Message to display
		EXIT_CBSCRIPT,  // Callback for clicking "Exit"
		"",             // Callback for clicking "Continue"
		bAllowContinue, // Display the "Continue" button?
		"SCREEN_MESSAGEBOX_DEFAULT",
		-1,             // Okay string ref
		EXIT_BUTTON,    // Override Okay button name
		-1,             // Cancel string ref
		CONTINUE_BUTTON // Override Cancel button name
	  );
    }
  }
}

// ------------------------------------------------------------
// gui_exit_to_menu
/*
    Exit the game and return to the starting menu.
*/
// RJH 07/09/10

void main()
{
  CloseGUIScreen( OBJECT_SELF, "SCREEN_MESSAGEBOX_DEFAULT" );
  EndGame( "" );
}
// ------------------------------------------------------------
#include "endgame_if_wrong_pc"

void main()
{
...
  // End the game if the PC is not the expected character
  // WARNING: Do not set the third parameter of endgame_if_wrong_pc()
  // to FALSE during testing or you can become locked in a loop.
  string sResName = "calad_whitecinder";
  string sExitMsg = "This module is designed to be run with " +
    "the pregenerated character named Calad Whitecinder.";
  endgame_if_wrong_pc( sResName, sExitMsg, TRUE );
...
}

Select All Text | View Code in separate window

Patch

1.00

NWN2Game

All

Description

Sometimes a module author may intend the work for a specific loadable PC, rather than a general character that is generated by the player. This allows the module writer to fine tune the story to fit an individual. The code below can be used to test whether the appropriate character was loaded. Note: It is also a good idea to mention in the module notes the name of the character that needs to be loaded.

The code is the concatenation of three files: (1) endgame_if_wrong_pc, (2) gui_exit_to_menu, and (3) a code snippet that is placed in the "On Client Enter Script" of the module.

The "endgame_if_wrong_pc" code compares the character selected by the player to a creature blueprint. If the parameters of the two do not match, a dialog message appears and the game returns to the starting menu.

The endgame_if_wrong_pc routine creates a copy of the template creature then performs a series of comparisons with the is_pc_match() routine. If a parameter doesn't match, a DisplayMessageBox, is displayed. When the player selects the "Exit" button,
the "gui_exit_to_menu" call-back routine
is called to perform the exit.

The endgame_if_wrong_pc() routine should be called from the "On Client Enter Script" of the module's starting area. The "endgame_if_wrong_pc" script is included, and a call such as is used in the final code snippet should be made, with the parameters adopted to match your module.

A prototype template could be generated, for example, using the InCharacter plug-in.

Files

Name	Type	Size	Downloads
NO FILES

SCORE OUT OF 10

N/A
Cast Your Vote!
Voting FAQ

PORTFOLIO

Add this entry to your portfolio so you can track it

Manage your existing portfolios or create a new one.

SCREENS

No Images

You Must Be Logged In to Participate.

Comments (0):

You must be Logged In to post comments in this section.

NWN2 Voting Standards

10 - A Masterpiece, Genuinely Groundbreaking
9 - Outstanding, a Must Have
8 - Excellent, Recommended to Anyone
7 - Very Good, Deserves a Look
6 - Good, Qualified Recommendation
5 - Fair, Solid yet Unremarkable
4 - Some Merit, Requires Improvements
3 - Poor Execution, Potential Unrealized
2 - Very Little Appeal
1 - Not Recommended to Anyone