Skins: |

NWN SCRIPTS

- Jump to comments -

Title

Player Character Auto Save by IntrepidCW

Author

IntrepidCW

Submitted / Updated

04-13-2004 / 11-22-2006

Category

Scripting routines

Expansions

SOU-1.62

View Code

/* 
This robust code allows you to export reliablily all the player characters in a game, no need to use the 'autosave game' feature or the dangerous ExportAllCharacters() fucntion.
The PC autosaving is triggered by a timer (everything easily configurable) and shows a message (can be set off).
The last version uses a trick to avoid excesive hard disk usage picks when saving all PCs.

There is a very improved version of another similar scripts in the vault.
The original functions 'Export*', unfortunately, don't work if used when the character is not in an area (it is loading another area). This script is more robust because it makes a second trial in a few seconds if the PC cannot be saved (furthermore it uses 'exportsinglecharacter' in every PC in the module, instead of ExportAll).
The messages help to know how often the PCs are not saved (in this manner you can set a correct saving time)
The zip includes an .erf (compiled with HotU 1.62) and the code in .txt archives, for SoU or NWNClassic users. It contains the include file, and an *example* OnModuleLoad script.
Two versions: english and spanish.

Furthermore it provides two new functions you can use if needed:
ExportSingleCharacterFix()
ExportAllCharactersFix()
Both improved original functions.

Note: Sorry for the bad english (feel free to correct me :) )
*/



/*
INSTALLATION:

Import the erf file (if you cant, copy and paste the code from the two txt files: 'onmoduleload' and 'pc_export_inc', into two new scripts, then compile).

If your module 'onmoduleload' slot is empty, simply use the script with the proper name in that slot.

In other case you must implement the code and delete the script 'onmoduleload' that comes with the erf
(if should not be dificult):
 //-----------------------------------------------
  In the Module 'OnModuleLoad' script write:

    #include "pc_export_inc"

  before the main
  and

    pc_export_onmoduleload();

  after the main
 //-----------------------------------------------


Note that you have an english version and a spanish version.
*/









//***************************************************************************
// PC_EXPORT_INC ***********************************************************
//***************************************************************************
// pc_export_inc
// Player Characters autosaving function
// Updated: 13-11-2004   IntrepidCW

//***************************************************************************
/*
INSTALLATION:
You need this script, no need to make modifications, except constants
in order to turn options on and off. You could also modify messages.
Tips: You could also save PCs when they sleep, to complement the use of the
timer saving.

In the Module 'OnModuleLoad' script write:

#include "pc_export_inc"

before the main
and

pc_export_onmoduleload();

after the main
*/
//***************************************************************************


//***************************************************************************
// CONSTANTS

//Sets on (TRUE) or off (FALSE) the autosaving for PCs
const int b_charautosavestate = TRUE;
//Time between each saving (seconds)
const float f_autoexportdelay = 60.0;
/*if it fails, time for the second trial, seconds (for each character).
0.0 = No second trial*/
const float f_autoexportdelaytry2 = 1.0;
//How many second intents must we do
const int f_autoexporttry2MaxCounter = 15;
//Turn messages on or off  (off FALSE, on TRUE)
const int b_autoexportmessage = FALSE;
/*Time between the Module loads in the server and the first pc saving, in seconds
*/
const float f_autoexportinitime = 300.0;
/*Export all characters in a instant suposses too much work for the hard drive,
it instroduces a moment of lag in the server if there are too much PCs. This
value introduces a small delay between each PC saved. Make it small in order
to avoid problems (script does not check it in order to let you make what you
want)
Recomendation: Must be less than
( f_autoexportdelay - f_autoexportdelaytry2*f_autoexporttry2MaxCounter ) / max_number_of_PCs_on_server
E.g., with default values, with a server for 20 players.
 < (60-1*15)/20, it is <2.25
A second is more than enough, if you dont want to have this delay, use 0.0
*/
const float f_export_timeforpc = 0.5;
/* Exporting PCs with the PrC Shifter who are polymorphed, can damage their stats.
If FALSE, it will not save morphed Shifters (default), If TRUE it will save them
anyways. They would not be saved if they are Shifters using the Druid Wild Shape.
*/
const int b_export_morphed_shifters = FALSE;

//***************************************************************************




//**********************************************************************
//*********************************************************************
// FUNCTIONS


//****************************************************************************
/*Says if the PC has levels in the PrC Shifter and he is morphed, to avoid NWN
Bugs. It will also return TRUE if the PC is a Shifter using the Druid Wild Shape.
Returns TRUE if Morphed Shifter, FALSE if not. */
int IsShifterMorphed(object oPC)
{
    effect ef = GetFirstEffect(oPC);
    int iShifter = FALSE;
    if (GetLevelByClass(CLASS_TYPE_SHIFTER,oPC)>0)  //Is Shifter, search the PolyEff
    while( GetEffectType(ef) != EFFECT_TYPE_INVALIDEFFECT && iShifter == FALSE)
    {
        if ( GetEffectType(ef) == EFFECT_TYPE_POLYMORPH
            && GetLevelByClass(CLASS_TYPE_SHIFTER,oPC)>0
            /*&& GetAppearanceType(oPC) <= 6*/)
            iShifter = TRUE;
        ef = GetNextEffect(oPC);
    }
    return iShifter;
}
//---------------------------------------------------------------------------




//****************************************************************************
/*It is used for the PC autosaving second trial, if the first time it failed*/
void autoexportfunction2 (object oPlayer, int fb_export_morphed_shifters = FALSE, float fSecondTryDelay = f_autoexportdelaytry2, int fiMaxCounter = f_autoexporttry2MaxCounter, int fiCounter = 1)
{
  if ( GetArea(oPlayer) != OBJECT_INVALID && (IsShifterMorphed(oPlayer) == FALSE || fb_export_morphed_shifters == TRUE)  )
   {
     ExportSingleCharacter(oPlayer);
     if (b_autoexportmessage ==TRUE)
     SendMessageToPC(oPlayer, "Second intent to save character sucessfull");
   }
   else
    {
       if (fiCounter >= fiMaxCounter)
       {
         if (b_autoexportmessage ==TRUE)
         SendMessageToPC(oPlayer, "Second intent to save character failed");
       }
       else
       {
         DelayCommand(fSecondTryDelay, autoexportfunction2(oPlayer, fb_export_morphed_shifters, fSecondTryDelay, fiMaxCounter, fiCounter+1)  );
       }
    }
}
//---------------------------------------------------------------------------




//****************************************************************************
/*
Saves a character in a secure manner. Works as ExportSingleCharacters(), but, if
the PC cannot be saved (because he is loading another area) it makes another trial
after some seconds have passed.
The time for the second try can be modified with SecondTryDelay (seconds)
If fSecondTryDelay is 0.0 there is no second trial.
*/
void ExportSingleCharacterFix(object oPlayer, int fb_export_morphed_shifters = FALSE, float fSecondTryDelay = f_autoexportdelaytry2, int fMaxCounter = f_autoexporttry2MaxCounter)
{
   //Si el personaje no estaba cambiando de Area, se guardo bien
   if ( GetArea(oPlayer) != OBJECT_INVALID && (IsShifterMorphed(oPlayer) == FALSE || fb_export_morphed_shifters == TRUE)  )
    {
      ExportSingleCharacter(oPlayer);
      if (b_autoexportmessage ==TRUE)
        SendMessageToPC(oPlayer, "Character Saved");
    }
   //Sino el personaje estaba cambiando de Area y no se guardo
   else
    {
      if (b_autoexportmessage ==TRUE)
        if (GetArea(oPlayer) == OBJECT_INVALID)
            SendMessageToPC(oPlayer, "Your character wasnot saved because you were travelling from one are to another. It will try another time in the next 15 seconds. Tell to DMs if it is not correct.");
            else
            SendMessageToPC(oPlayer, "Your character wasnot saved because you are a Shifter and you were Polymorphed. It will try another time in the next 15 seconds. Tell to DMs if it is not correct.");
      if (b_autoexportmessage ==TRUE)
        SendMessageToAllDMs (GetName(oPlayer)+" ExportPC possible error.");
      //Segundo intento de guardado
      if (fSecondTryDelay > 0.0)
        DelayCommand(fSecondTryDelay, autoexportfunction2(oPlayer, fb_export_morphed_shifters, fSecondTryDelay, fMaxCounter) );
    }
}
//---------------------------------------------------------------------------



//****************************************************************************
/*
 ExportAllCharacters() improved.
 Can Export all characters every 'ff_autoexportdelay' seconds (optional) Note
 that this event triggers itself, on a timer, when finished -- until the module
 is unloaded.
 If a PC cannot be exported, it can make a second trial after some seconds
    (optional, specify a number of seconds to use the option)
 */
 /*
 Para que active el autoguardado temporizado: ff_autoexportdelay debe ser positivo > 0.0
 Para que NO haga un segundo intento: fSecondTryDelay debe ser 0.0
 ff_export_timeforpc: Indica el tiempo que pasa entre que CADA personaje es guardado
    esto evita sobrecarga del disco duro por guardar todos los PJs en un instante.
 */
 /*Notas sobre la funcion original ExportAllCharacters():
    This function is not very robust, this script works in another way.
 Note that PCs that are not in an area cannot be saved. (it is a bug/feature of
 the ExportCharacter functions). It the first trial is failed
 we try it a second time.
 Furthermore ExportAll original corrupts some data of PCs with the PrC Shifter.
 */
void ExportAllCharactersFix(int fb_export_morphed_shifters = FALSE, float fSecondTryDelay = f_autoexportdelaytry2, float ff_export_timeforpc = f_export_timeforpc, float ff_autoexportdelay = 0.0, int fMaxCounter = f_autoexporttry2MaxCounter)
{
 object oPlayer = GetFirstPC();
 float fDelayPerPC = 0.0;
  while ( oPlayer!= OBJECT_INVALID )
  {
   if (ff_export_timeforpc > 0.0)
    DelayCommand (fDelayPerPC, ExportSingleCharacterFix(oPlayer, fb_export_morphed_shifters, fSecondTryDelay, fMaxCounter) );
    else
        ExportSingleCharacterFix(oPlayer, fb_export_morphed_shifters, fSecondTryDelay);

   fDelayPerPC = fDelayPerPC + ff_export_timeforpc;
   oPlayer = GetNextPC();//next PC
  }//end of while
 if (ff_autoexportdelay > 0.0)
    DelayCommand(ff_autoexportdelay , ExportAllCharactersFix(fb_export_morphed_shifters, fSecondTryDelay , ff_export_timeforpc, ff_autoexportdelay, fMaxCounter));
    //delay to next save
}
//---------------------------------------------------------------------------



//****************************************************************************
//Sets the autosaving for PCs
/* Start the export characters timer */
//Incorporate this code into Module::OnLoad
//This function must be called by the script in Module's 'OnModuleLoad'.
//When the 'f_autoexportinitime' time passes the autosaving function is executed.
void pc_export_onmoduleload()
{
    if (b_charautosavestate == TRUE)
        DelayCommand(f_autoexportinitime, ExportAllCharactersFix(b_export_morphed_shifters, f_autoexportdelaytry2 , f_export_timeforpc, f_autoexportdelay, f_autoexporttry2MaxCounter) );
}
//---------------------------------------------------------------------------



//********************************************************************
//********************************************************************


//********************************************************************
//********************************************************************






















//****************************************************************************
// ONMODULELOAD ***********************************************************
//****************************************************************************
//On module load
//(Example)


//***************************************************************************
// CONSTANTS



//***************************************************************************


//PCs Autosaving
#include "pc_export_inc"


void main()
{

//****************************************************************************
//PCs Autosaving function
pc_export_onmoduleload();
//----------------------------------------------------------------------------


}   //end of main
//********************************************************************
//********************************************************************

Select All Text | View Code in separate window

Format

Code Only

Type

Type - Other

Includes

BioWare Standard

Description

This robust code allows you to export reliabily all the PCs in a game, no need to use the 'autosave game' feature or the dangerous ExportAllCharacters() function. The PC autosave is triggered by a timer. Last version avoids excesive hard disk usage picks when saving all PCs, and avoids the Shifter PrC Bugs. Easy configuration. There is a very improved version of another similar scripts in the vault. The original functions 'Export*', don't work if used when the character is not in an area (it is loading). This script is more robust because it makes second trials in a few seconds if the PC cannot be saved. The messages help you to set a correct saving time. The zip includes an .erf (HotU 1.64) and the code in .txt archives, for SoU users. It contains the include file, and an *example* OnLoad script. Two versions: english and spanish. Two new functions: ExportSingleCharacterFix() ExportAllCharactersFix() Note: Sorry for the bad english.

Files

Name	Type	Size	Downloads
ICWPCAutosave.zipICWPCAutosave.zip Submitted: 04-13-2004 / Last Updated: 11-13-2004	zip	18.62Kb	937
--

SCORE OUT OF 10

10
1 votes
View Stats
Cast Your Vote!

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 (14):

Posted by bossman at 2007-04-23 08:59:54

How can i tell if this is working?
I did what you said but do not see a prompt saying it was saved. seems simple to impliment your script but don't know if its working can you help I just want to do away with the auto save screen that comes up w/ the searver save. I' read throuh most of this vault and this is about the four differnt angle i have tryed to get my searver to save on its owen someone please send me an e-mail if you can help. sorry for spamming for help here.

Posted by Snye at 2006-03-10 11:49:17

I will have to check this out. I downloaded the database you made, and I thought it was done well other than I can't get the locations to be saved properly. Demo works, but not my mod... going to test a few other things and then I want to download this to see how well it works. When does this save the character? When they zone or level? Or does a certain number of minutes go by between saves?

Posted by Draco Celtae at 2005-08-21 17:15:02

Hey. I hope you still check this thread, 'cause I need a little help with your script. I've installed it in my PW mod, and it is amazing! *BUT* my problem is this.

Whenever the PC's are saved, I get the "PC saved to vault" message twice.
As well as the other messages that go off when trying to save during area trans.

All messages show up in double. What am I doing wrong?

Posted by Cuthbert503 at 2005-06-11 00:57:19 Voted 10.00 on 06/11/05

Posted by Cryolithic ( 142.179.xxx.xxx ) at 2004-12-01 23:35:00

Although this does work for shifters, it doesn't avoid problems with characters using the shapeshift spell.

Posted by IntrepidCW at 2004-11-13 15:21:00

Update!
Now PCs with the Shifter PrC are safe, and the way to do the second intents is better.
Difficult to improve now.

Posted by IntrepidCW at 2004-09-25 11:37:00

Update bug Fixed now. If you are using an old version of the script, you only need to overwrite the include file.

Posted by IntrepidCW at 2004-09-23 11:20:00

I have send a broken updated version. I have solved the bug, and i will send soon the correct script.

Posted by IntrepidCW at 2004-04-21 09:58:00

Not at all!
If someone is having problems with the script, or is thinking in useful modifications, please post there or use the mail address.

Posted by donnykrun at 2004-04-15 19:50:00

IntrepidCW,
Thanks for posting this script. This will definitely be useful in my PW module. I like this better than the the selectable in game autosave feature since it only saves the PC's to the server vault which is all I care for it to do.

Posted by IntrepidCW at 2004-04-14 14:22:00

Updated.
Now it is easier to implement, only an include script is needed, as well as two lines of code in the 'onmoduleload' script.

If the module hasn't a onmoduleload script, one sample script is provided.

Posted by IntrepidCW at 2004-04-14 10:25:00

Besalope is rigth, PCs are saved in their correct directory, depending of the type of game.

Posted by besalope at 2004-04-14 09:46:00

actually, if this is used with server vault PCs, then it exports the PCs to the server vault, not to the local vault (learned this from DM Akalima of the UO: NWN server). This is good for PWs that might go down and don't want to deal with people complaining that they lost a ton of xp, gold, items, etc.
_________________________
-I pwn n00bs-

Posted by IntrepidCW at 2004-04-14 08:27:00

It forces the game to export the player characters in the game to the local vault. It is better than saving the entire game (don't slowers the game, no lag).
It saves: xp, gold, stats, objects of the PC... never locations or actual hitpoints (excellent scripts in the vault will do that).

It doesn't use any database, and don't interferes with any permanency system. It only makes sure that the Player Characters information is always safe even if the server falls down.

I hope it answers the question.

(Note: don't use it in a solo game, because in a solo game NWN don't overwrite the character, it makes a copy)

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