Skins: |

NWN2 SCRIPTS

- Jump to comments -

Name

Nalencer's Companion Influence System

Author

Nalencer

Submitted / Updated

01-31-2009 / 11-19-2009

Category

Scripting routines

Forum Thread

Link

Type

Type - Reputations

Format

Code Only

ShowCode

//::///////////////////////////////////////////////
//:: Nalencer's Companion Influence System
//:: ginc_influence
//:: Copyright (c) 2009 Ethan Meanor
//:://////////////////////////////////////////////
/*
    The main include file to handle companion
	influence.
*/
//:://////////////////////////////////////////////
//:: Created By: Ethan Meanor
//:: Created On: February 1, 2009
//:://////////////////////////////////////////////

#include "ginc_var_ops"


//-------------------------------------------------
// Prototypes
//-------------------------------------------------
void ModifyInfluence(string sCompanion, string sChange);
void ReportInfluenceChange(string sCompanion, string sChange);
void UpdateInfluenceBand(string sCompanion);
void ApplyInfluenceEffects(string sCompanion);
void SetIsPossessable(object oCompanion, int bPossessable);
void SetPlayerInventoryAccess(object oCompanion, int bCanAccessInventory);

int GetCompanionInfluence(string sCompanion);
int GetCompanionInfluenceBand(string sCompanion);

string GetInfluenceVariable(string sCompanion);
string GetInfluenceBandVariable(string sCompanion);


//-------------------------------------------------
// Constants
//-------------------------------------------------
// *** USER PREFERENCES -- THIS SECTION CAN BE EDITED ***
// Maximum influence level
const int MAXIMUM_INFLUENCE = 100;
// Minimum influence level
const int MINIMUM_INFLUENCE = -100;
// If TRUE, bWillLeaveParty will be set to TRUE when the companion reaches minimum influence
// This is just for convenience, and can be used in whatever way you wish
const int COMPANIONS_LEAVE_PARTY = TRUE; 

// Influence range definitions
// These can be set to whatever values you wish
const int INFLUENCE_RANGE_REBELLIOUS 	= -76;
const int INFLUENCE_RANGE_DISILLUSIONED = -51;
const int INFLUENCE_RANGE_WAVERING 		= -26;
const int INFLUENCE_RANGE_NEUTRAL 		= 25;
const int INFLUENCE_RANGE_TRUSTING 		= 50;
const int INFLUENCE_RANGE_LOYAL 		= 75;
const int INFLUENCE_RANGE_DEVOTED 		= 99;
const int INFLUENCE_RANGE_LOVE	 		= 100;


// *** SYSTEM CONSTANTS -- DO NOT EDIT THIS SECTION ***
const int INFLUENCE_BAND_REBELLIOUS 	= -3;
const int INFLUENCE_BAND_DISILLUSIONED 	= -2;
const int INFLUENCE_BAND_WAVERING 		= -1;
const int INFLUENCE_BAND_NEUTRAL 		= 0;
const int INFLUENCE_BAND_TRUSTING 		= 1;
const int INFLUENCE_BAND_LOYAL 			= 2;
const int INFLUENCE_BAND_DEVOTED 		= 3;

const string PREFIX_INFLUENCE = "i_";
const string PREFIX_INFLUENCE_BAND = "ib_";
const string PREFIX_LEAVE_PARTY = "bWillLeaveParty_";

const string SOUND_INFLUENCE_GAIN = "gui_infuencegain01";
const string SOUND_INFLUENCE_LOSS = "gui_infuenceloss01";


//-------------------------------------------------
// Global Variables
//-------------------------------------------------
object oPC = GetFirstPC();


//-------------------------------------------------
// Definitions
//-------------------------------------------------

// Modify companion influence
void ModifyInfluence(string sCompanion, string sChange)
{
	string sName = GetName(GetObjectByTag(sCompanion)); 	// companion name
	string sInfluence = GetInfluenceVariable(sCompanion); 	// influence variable
	int nOldValue = GetGlobalInt(sInfluence); 				// original influence
	int nNewValue = 0; 										// new influence value

	nNewValue = CalcNewIntValue(nOldValue, sChange, TRUE);  // calculate new value
	
	// make sure that the new value is between the minimum and maximum values
	if (nNewValue < MINIMUM_INFLUENCE)
		nNewValue = MINIMUM_INFLUENCE; 
	else if (nNewValue > MAXIMUM_INFLUENCE)
		nNewValue = MAXIMUM_INFLUENCE;
	
	// if COMPANIONS_LEAVE_PARTY = TRUE and influence is at minimum, flag the companion as ready
	// to leave the party	
	if (COMPANIONS_LEAVE_PARTY == TRUE && nNewValue == MINIMUM_INFLUENCE)
	{
		SetGlobalInt(PREFIX_LEAVE_PARTY + sName, 1); // companion will leave party
	}
	else
	{	
		SetGlobalInt(PREFIX_LEAVE_PARTY + sName, 0); // companion will not leave party
		
		SetGlobalInt(sInfluence, nNewValue); // set new influence value
	
		ReportInfluenceChange(sCompanion, sChange); // report change to player
	
		UpdateInfluenceBand(sCompanion);	// update influence band
		ApplyInfluenceEffects(sCompanion);  // apply influence effects
	}
}


// Report influence change to the player
void ReportInfluenceChange(string sCompanion, string sChange)
{ 
	string sName = GetName(GetObjectByTag(sCompanion)); 			   // companion name
	int nInfluence = GetGlobalInt(GetInfluenceVariable(sCompanion));   // influence variable
	
	if (StringToInt(sChange) < 0) // influence loss
	{
   		SendMessageToPC(oPC, "Lost influence with " + sName + ": " + sChange + " (Total: " + IntToString(nInfluence) + ")");
   		SetNoticeText(oPC, "Lost influence with " + sName + ": " + sChange + " (Total: " + IntToString(nInfluence) + ")");
		PlaySound(SOUND_INFLUENCE_GAIN);
	}	
	else // influence gain
	{
		SendMessageToPC(oPC, "Gained influence with " + sName + ": +" + sChange + " (Total: " + IntToString(nInfluence) + ")");
   		SetNoticeText(oPC, "Gained influence with " + sName + ": +" + sChange + " (Total: " + IntToString(nInfluence) + ")");
		PlaySound(SOUND_INFLUENCE_LOSS);
	}
}
	

// Update the variable which keeps track of the companion's influence band.	
void UpdateInfluenceBand(string sCompanion)
{
	int nInfluence = GetGlobalInt(GetInfluenceVariable(sCompanion));   // influence variable
	string sInfluenceBand = PREFIX_INFLUENCE_BAND + sCompanion; 	   // influence band variable
	
	// check influence level and set the appropriate influence band
	if (nInfluence <= INFLUENCE_RANGE_REBELLIOUS)
		SetGlobalInt(sInfluenceBand, INFLUENCE_BAND_REBELLIOUS);
	else if (nInfluence <= INFLUENCE_RANGE_DISILLUSIONED)
		SetGlobalInt(sInfluenceBand, INFLUENCE_BAND_DISILLUSIONED);
	else if (nInfluence <= INFLUENCE_RANGE_WAVERING)
		SetGlobalInt(sInfluenceBand, INFLUENCE_BAND_WAVERING);
	else if (nInfluence <= INFLUENCE_RANGE_NEUTRAL)
		SetGlobalInt(sInfluenceBand, INFLUENCE_BAND_NEUTRAL);
	else if (nInfluence <= INFLUENCE_RANGE_TRUSTING)
		SetGlobalInt(sInfluenceBand, INFLUENCE_BAND_TRUSTING);
	else if (nInfluence <= INFLUENCE_RANGE_LOYAL)
		SetGlobalInt(sInfluenceBand, INFLUENCE_BAND_LOYAL);
	else if (nInfluence <= INFLUENCE_RANGE_DEVOTED)
		SetGlobalInt(sInfluenceBand, INFLUENCE_BAND_DEVOTED);
}


// Apply influence effects
void ApplyInfluenceEffects(string sCompanion)
{
	object oCompanion = GetObjectByTag(sCompanion);					
	int nInfluenceBand = GetGlobalInt(PREFIX_INFLUENCE_BAND + sCompanion); // influence band variable
	
	// restore defaults
	int bPossessable = TRUE;		 // possessable
	int bCanAccessInventory = TRUE;  // inventory accessible
	
	// check influence band and apply the appropriate effects
	switch (nInfluenceBand)
	{
		case INFLUENCE_BAND_REBELLIOUS:
			bPossessable = FALSE;		 // unpossessable
			bCanAccessInventory = FALSE; // inventory not accessed
			break;
		
		case INFLUENCE_BAND_DISILLUSIONED:
			bPossessable = TRUE;		 // possessable
			bCanAccessInventory = FALSE; // inventory not accessible
			break;
			
		case INFLUENCE_BAND_WAVERING:
			// add effects here
			break;
			
		case INFLUENCE_BAND_NEUTRAL:
			// add effects here
			break;

		case INFLUENCE_BAND_TRUSTING:
			// add effects here
			break;
			
		case INFLUENCE_BAND_LOYAL:
			// add effects here	
			break;
			
		case INFLUENCE_BAND_DEVOTED:
			// add effects here
			break;
	}
	
	SetIsPossessable(oCompanion, bPossessable); 				// set possessability
	SetPlayerInventoryAccess(oCompanion, bCanAccessInventory);  // set inventory access
}


// Set whether player can possess companion
void SetIsPossessable(object oCompanion, int bPossessable)
{
	int bBlocked = !bPossessable;
	SetIsCompanionPossessionBlocked(oCompanion, bBlocked);
}


// Set whether player can access companion inventory
void SetPlayerInventoryAccess(object oCompanion, int bCanAccessInventory)
{
	int bDisableEquip = !bCanAccessInventory;
	// TRUE = equipment disabled
	SetLocalInt(oCompanion, "X2_JUST_A_DISABLEEQUIP", bDisableEquip);
}


// return current companion influence level
int GetCompanionInfluence(string sCompanion)
{
	string sInfluence = GetInfluenceVariable(sCompanion);
	int nInfluence = GetGlobalInt(sInfluence);
	
	return nInfluence;	
}


// return current companion influence band
int GetCompanionInfluenceBand(string sCompanion)
{
	string sInfluenceBand = GetInfluenceBandVariable(sCompanion);
	int nInfluenceBand = GetGlobalInt(sInfluenceBand);
	
	return nInfluenceBand;	
}


// return name of the companion's influence variable
string GetInfluenceVariable(string sCompanion)
{
	string sInfluence = PREFIX_INFLUENCE + sCompanion;
	return sInfluence;	
}


// return name of the companion's influence band variable
string GetInfluenceBandVariable(string sCompanion)
{
	string sInfluenceBand = PREFIX_INFLUENCE_BAND + sCompanion;
	return sInfluenceBand;	
}

Select All Text | View Code in separate window

Patch

1.23

NWN2Game

All

Description

Owing to the lack of any easily accessible companion influence system, either in the game resources or on the Vault, I decided to create this simple, flexible script. It allows for management of the influence of any number of companions, with no scripting knowledge required. With a bit of scripting knowledge, however, a builder can modify the script extensively, adding custom actions to be taken depending on the companion and influence level, etc. This system is a great package for beginners, and a great starting point for experts.

INSTALLATION
Installation is very simple: just click on the File menu in the toolset, select �Import� and choose the �influence.erf.� file. This should install the scripts 'ginc_influence', 'ga_influence' and 'gc_influence' in your module.

SPECIFICS
The system works on a 200-point scale, from -100 to +100. As the player gains and loses influence with his companions, they will move through different influence bands, ranging from �rebellious� to �devoted�. All of these values can be easily changed through the user preferences at the top of the �ginc_influence� script.

- At 'disillusioned' the player will no longer be able to access the companion's inventory.
- At 'rebellious' the player will not be able to access the companion's inventory or take control of the companion.

Aside from these, there are no hard-coded effects based on influence band. These effects can also be easily removed within the script if the builder so desires.

Use the 'ga_influence' script to set influence in conversation; use the 'gc_influence' script to retrieve influence level in conversation.

Experienced scripters should find the code relatively straightforward, and should have no trouble modifying it to suit their needs.

CONTACT
If you have feedback, questions, problems, etc., I can be contacted at [email protected].

Files

Name	Type	Size	Downloads
influence.erfinfluence.erf Submitted: 01-31-2009 / Last Updated: 01-31-2009	erf	9.88Kb	209
Contains all necessary scripts.
README.txtREADME.txt Submitted: 01-31-2009 / Last Updated: 01-31-2009	txt	1.94Kb	325
Description and basic instructions.

SCORE OUT OF 10

9.63
2 votes
View Stats
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 (3):

Posted by nicethugbert at 2009-11-02 07:41:49 Voted 10.00 on 11/02/09

NEAT!
_________________________
NTB's Hills and Valleys Vol. 00

Posted by Nalencer at 2009-10-27 08:26:35

Glad someone found some use for it :D
_________________________
Development Blog

Posted by Rythorn at 2009-10-24 11:06:54 Voted 9.25 on 10/24/09

Very useful.

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