|
|
| (191 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| − | UNDER CONSTRUCTION
| + | #REDIRECT [[Compatible_Companion_Mod_Creation]] |
| − | | + | |
| − | Created by Idomeneas
| + | |
| − | | + | |
| − | Please do not edit this, unless you found a mistake. In that case inform me first.
| + | |
| − | | + | |
| − | The purpose of this wiki is to help the modder community tackle one of the most important problems we face: compatibility between all our mods, in particular those mods that introduce NPC followers.
| + | |
| − | | + | |
| − | I'll share with you my approach to handling companions, based on what I have done with my mod, [http://social.bioware.com/project/3152/ Valeria Addon], my experiments and experience. My goal has always been to be the least intrusive to the game core resources (meaning don't change them at all if possible), while having the companion behave appropriately in most parts of the game.
| + | |
| − | | + | |
| − | What I'll talk about here works for Patch 1.02. If you got Awakening or Patch 1.04 you'll see weird behavior and this approach might have to be altered.
| + | |
| − | | + | |
| − | Let us begin.
| + | |
| − | | + | |
| − | =Understanding the game mechanics and the module event script=
| + | |
| − | | + | |
| − | We first need to discuss how the game makes use of scripts, and in particular our module event scripts (every mod has one). Everytime something happens in the game, e.g., you open or close the inventory, talents, skills, or world map gui, all the module event scripts you have installed are fire and processed (probably in the order the mods where installed) as well as the core game scripts (typically these are processed first).
| + | |
| − | | + | |
| − | So if we want to capture the behavior of our NPC follower or a major event of the game it can be done here, e.g., the PC selected or dropped the follower in the partypicker, you begin travel, or the PC just finished talking to everyone at the gates in the climax, or the game is over and we're at the slideshow.
| + | |
| − | | + | |
| − | This game stucture is indeed brilliant since it allows the main game and all mods installed to handle and process the same event, say EVENT_TYPE_BEGIN_TRAVEL or EVENT_TYPE_MODULE_HANDLE_GIFT or EVENT_TYPE_WORLD_MAP_CLOSED and so forth.
| + | |
| − | | + | |
| − | =What we can't and can do=
| + | |
| − | | + | |
| − | The only major resource we have to change is the partypicker, otherwise our NPC's won't show up. There is a way around this(item 4 below).
| + | |
| − | | + | |
| − | If you want your NPC to interject in the middle of a major dialog, that dialog resource has to be changed (I can't see any way around this one).
| + | |
| − | | + | |
| − | The thing to keep in mind is that everytime something happens in the game, certain flags from core game resources are set. We can capture when these are set and continue the process appropriately.
| + | |
| − | | + | |
| − | In this way, I'll show you how '''we can do''' the following (I've done these for my mod Valeria, WITHOUT changing any core game resources, I'll use her as a reference):
| + | |
| − | | + | |
| − | 1) Valeria banters with the party randomly WITHOUT changing any original game scripts.
| + | |
| − | | + | |
| − | 2) Valeria accepts specific gifts WITHOUT changing the game scripts.
| + | |
| − | | + | |
| − | 3) Valeria is in a nightmare area WITHOUT changing the game scripts.
| + | |
| − | | + | |
| − | 4) Valeria has a dialog option to eliminate problems with partypicker compatibility. If she doesn't show up in the partypicker she can still be picked up or sent back to camp.
| + | |
| − | | + | |
| − | 5) Valeria has her own dialog after major cutscenes (where appropriate) of the game WITHOUT changing resources of the game.
| + | |
| − | | + | |
| − | 6) Valeria appears in all camps (basic camp, Arl Eamon's estates, post coronation), most cutscenes from the original game and at the city gates WITHOUT changing resources of the game.
| + | |
| − | | + | |
| − | 7) Valeria behaves appropriately if the PC gets captured WITHOUT changing resources of the game.
| + | |
| − | | + | |
| − | 8) Slideshow post coronation WITHOUT changing the resources of the game.(Haven't included it in my mod yet, but it's done)
| + | |
| − | | + | |
| − | =What do we need?=
| + | |
| − | | + | |
| − | Well, basic knowledge of the toolset and scripting.
| + | |
| − | | + | |
| − | a) The NPC mod event handler, say "valeria_event_handler"
| + | |
| − | | + | |
| − | b) A plot to hold all our NPC flags, call it "valeria_npc_hire". In the handler we should have the include:
| + | |
| − | | + | |
| − | '''#include "plt_valeria_npc_hire"'''
| + | |
| − | | + | |
| − | c) We need the following basic FLAGS: PARTY_VALERIA_IN_PARTY, PARTY_VALERIA_JOINED, VALERIA_CHECK_RUNIT
| + | |
| − | | + | |
| − | These are there to handle Valeria(is she in party?, has she joined? do we need to run the script? it has to be done if we're in a camp site. you'll see what script)
| + | |
| − | | + | |
| − | d) Other flags to set when needed: VALERIA_WYNNE_KILLED, VALERIA_RESPONSE_TO_BAD, VALERIA_ENTER_FADE, VALERIA_HAS_NIGHTMARE_A, VALERIA_HAS_NIGHTMARE_B, VALERIA_HAS_NIGHTMARE_C, VALERIA_SLOTH_DEMON_ATTACKS, VALERIA_SLOTH_DEMON_DEFEATED, VALERIA_WYNNE_KILLED_AT_CULLEN, VALERIA_DEN_CAPTURED_PC_CAPTURED, VALERIA_CLI_MAIN_PC_FINISHED_SETTING_FINAL_PARTY, VALERIA_EPI_JUMP_TO_SLIDE_SHOW, VALERIA_FIGHTING_ARCHDEMON
| + | |
| − | | + | |
| − | If you drop the valeria_ prefix you'll recognize some flags from the original game. Everytime those are set, we'll need to set a corresponding flag in our NPC plot, so we don't run thing twice.
| + | |
| − | | + | |
| − | I'll tell you which plots from the main game we need depending on what we're trying to do.
| + | |
| − | | + | |
| − | =Basic structure of the module event handler=
| + | |
| − | | + | |
| − | //core includes here
| + | |
| − | | + | |
| − | //core plot includes
| + | |
| − | | + | |
| − | //valeria function, plots etc, includes
| + | |
| − | | + | |
| − | '''#include "plt_valeria_npc_hire"'''
| + | |
| − | | + | |
| − | //constant definitions here
| + | |
| − | | + | |
| − | //function definitions here
| + | |
| − | | + | |
| − | (all this part 1)
| + | |
| − | | + | |
| − | void main()
| + | |
| − | {
| + | |
| − | object oPC = GetHero(),me=OBJECT_SELF,ohire;
| + | |
| − | event ev = GetCurrentEvent();
| + | |
| − | int nEventType = GetEventType(ev);
| + | |
| − | //function calls here, other important checks (part 2)
| + | |
| − | //capture events
| + | |
| − | switch(nEventType)
| + | |
| − | {
| + | |
| − | .....(part 3)
| + | |
| − | }
| + | |
| − | }
| + | |
| − | | + | |
| − | //functions here (part 4)
| + | |
| − | | + | |
| − | For what follows, I'll break the event script into four parts for quick reference: Includes, (Main) Body, (Event) Handling, Functions
| + | |
| − | | + | |
| − | =Capturing Main Campaign Event/Flag Changes=
| + | |
| − | | + | |
| − | The next script can be placed in the event handler, and allows us to capture and process main plot changes.
| + | |
| − | | + | |
| − | I'll do this structure a first time here
| + | |
| − | | + | |
| − | In 'includes' add:
| + | |
| − | | + | |
| − | void check_plot_changed(object oVal);
| + | |
| − | | + | |
| − | In 'body' add:
| + | |
| − | | + | |
| − | ...
| + | |
| − | object oVal=UT_GetNearestObjectByTag(oPC,"valeria_npc");
| + | |
| − | ...
| + | |
| − | check_plot_changed(oVal);
| + | |
| − | ...
| + | |
| − | | + | |
| − | In 'functions' add:
| + | |
| − | | + | |
| − | //check if plot flags changed act appropriately
| + | |
| − | | + | |
| − | void check_plot_changed(object oVal)
| + | |
| − | {
| + | |
| − | object oPC=GetHero();//if NPC has not joined return
| + | |
| − | if (!WR_GetPlotFlag(PLT_VALERIA_NPC_HIRE, PARTY_VALERIA_JOINED))
| + | |
| − | return;
| + | |
| − | | + | |
| − | //here depending on which core flag changed, act appropriately
| + | |
| − | .....
| + | |
| − | | + | |
| − | }
| + | |
| − | | + | |
| − | We will be changing this function appropriately below, depending on what we wish to do.
| + | |
| − | | + | |
| − | =Random banters without changing game scripts=
| + | |
| − | | + | |
| − | ==What we need==
| + | |
| − | A dialog resource, say "valeria_random_banter.dlg", a script "valeria_random_banters.nss" and a plot "plt_valeria_random_banters"
| + | |
| − | | + | |
| − | You will notice that they are done in order of appearance in the .dlg file. Of course one can change that. Meaning if Alistair is in, all his banters will go through first, then Moriggan, then Leliana ,etc, the way I had them in my file. To change that you can add a random chance to see if you initiate dialog with the party member.(see the script below, it is trivial)
| + | |
| − | | + | |
| − | ==valeria_random_banters.nss==
| + | |
| − | First create this script. You can see what flags you need in plt_valeria_random_banters below (basically a flag for each companion you want Valeria to banter with). Alternatively, you can use the core plots to check who is in the party, but I find this more efficient, since we got full control over the script and plot resource.
| + | |
| − | | + | |
| − | {//file valeria_random_banters.nss
| + | |
| − | | + | |
| − | '''#include "wrappers_h"'''
| + | |
| − | | + | |
| − | '''#include "plt_valeria_random_banter"'''
| + | |
| − | | + | |
| − | void main()
| + | |
| − | {
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, ALISTAIR_IN_PARTY, FALSE);
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, MORRIGAN_IN_PARTY, FALSE);
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, LELIANA_IN_PARTY, FALSE);
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, WYNNE_IN_PARTY, FALSE);
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, ZEVRAN_IN_PARTY, FALSE);
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, DOG_IN_PARTY, FALSE);
| + | |
| − | object [] arParty = GetPartyList(GetHero());
| + | |
| − | int i;
| + | |
| − | int nSize = GetArraySize(arParty);
| + | |
| − | int which=Random(nSize)+1;
| + | |
| − | if(GetTag(arParty[which]) == "gen00fl_alistair")
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, ALISTAIR_IN_PARTY, TRUE);
| + | |
| − | if(GetTag(arParty[which]) == "gen00fl_morrigan")
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, MORRIGAN_IN_PARTY, TRUE);
| + | |
| − | if(GetTag(arParty[which]) == "gen00fl_leliana")
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, LELIANA_IN_PARTY, TRUE);
| + | |
| − | if(GetTag(arParty[which]) == "gen00fl_wynne")
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, WYNNE_IN_PARTY, TRUE);
| + | |
| − | if(GetTag(arParty[which]) == "gen00fl_zevran")
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, ZEVRAN_IN_PARTY, TRUE);
| + | |
| − | if(GetTag(arParty[which]) == "gen00fl_dog")
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, DOG_IN_PARTY, TRUE);
| + | |
| − | }
| + | |
| − | }
| + | |
| − | | + | |
| − | //to add a random chance for the party member to banter with Valeria you can simply change
| + | |
| − | ...
| + | |
| − | if(GetTag(arParty[which]) == "gen00fl_dog" && Random(10)==1)
| + | |
| − | WR_SetPlotFlag(PLT_VALERIA_RANDOM_BANTER, DOG_IN_PARTY, TRUE);
| + | |
| − | ...
| + | |
| − | | + | |
| − | This way it won't circle through all the banters of Alistair, then Morrigan's etc, but it will skip them with some probability (90%).
| + | |
| − | | + | |
| − | ==Changes in valeria_event_handler==
| + | |
| − | I'll do this structure again(last time), the rest will be the same:
| + | |
| − | | + | |
| − | In 'includes' add:
| + | |
| − | | + | |
| − | void valeria_banter();
| + | |
| − | | + | |
| − | In 'body' add:
| + | |
| − | | + | |
| − | //valeria banter: run this only if valeria is in active party
| + | |
| − | if (WR_GetPlotFlag(PLT_VALERIA_NPC_HIRE, PARTY_VALERIA_IN_PARTY))
| + | |
| − | valeria_banter();
| + | |
| − | | + | |
| − | In 'functions' add:
| + | |
| − | | + | |
| − | void valeria_banter()
| + | |
| − | {
| + | |
| − | if(Random(400)!=1)//1 in 400 chance to start banter
| + | |
| − | return;
| + | |
| − | if(GetCombatState(GetHero()))//don't start if in combat
| + | |
| − | return;
| + | |
| − | object [] arParty = GetPartyList(GetHero());
| + | |
| − | int i;
| + | |
| − | int nSize = GetArraySize(arParty);
| + | |
| − | if(nSize<=2)//if only valeria and the PC no banter
| + | |
| − | return;
| + | |
| − | for(i=0;i<nSize;i++)
| + | |
| − | if(!ClearAmbientDialogs(arParty[i]))
| + | |
| − | return;
| + | |
| − | object oval=UT_GetNearestObjectByTag(GetHero(),"valeria_npc");
| + | |
| − | UT_Talk(oval,GetHero(),R"valeria_random_banter.dlg");
| + | |
| − | }
| + | |
| − | | + | |
| − | ==Structure of the file valeria_random_banter.dlg==
| + | |
| − | Everything should be set to AMBIENT. First notice where we call the random_banter_script.
| + | |
| − | | + | |
| − | [[image:Banters1.JPG]]
| + | |
| − | | + | |
| − | Now, notice how we structure all the npc's we want Valeria to banter with. First is Alistair, if he's in the party, and so forth.
| + | |
| − | | + | |
| − | [[image:Banters2.JPG]]
| + | |
| − | | + | |
| − | Notice that once a banter starts, it will never be shown again.
| + | |
| − | | + | |
| − | [[image:Banters3.JPG]]
| + | |
| − | | + | |
| − | An example with 3 NPC's (this is a dog banter with Valeria, and Zevran, if he's in the party(notice the condition C, using the valeria_random_banters flag) he joins in).
| + | |
| − | | + | |
| − | [[image:Banters4.JPG]] | + | |
