High-Level Character Generation - Revision history

Sunjammer: Reformatting, adding links

2011-08-20T08:39:42Z

Reformatting, adding links

Show changes

Jackkel dragon: /* Editing the module_core */ added a note

2010-12-23T17:48:37Z

‎Editing the module_core: added a note

Gaxkang55: /* Editing the module_core */

2010-12-22T09:44:09Z

‎Editing the module_core

Gaxkang55: /* Editing the module_core */

2010-12-22T09:39:30Z

‎Editing the module_core

Jackkel dragon: moved Character Generation at a level Higher than 1 to High-Level Character Generation: Sounds better

2010-10-13T19:11:40Z

moved Character Generation at a level Higher than 1 to High-Level Character Generation: Sounds better

Jackkel dragon: added forum thread

2010-10-13T18:19:45Z

added forum thread

Jackkel dragon: Jackkel Dragon's draft of the tutorial for high-level chargen

2010-10-13T18:13:09Z

Jackkel Dragon's draft of the tutorial for high-level chargen

New page

Note: This is a draft. Let me know on the BSN forum thread if these don't work or I'm unclear on what must be done.

==Introduction==
In the Awakening and post-Awakening DLC, anyone who created a new character may have noticed that the character generation screen didn't start at level 1. With this tutorial, custom modules made by players will be able to have similar funtionality.

==Creating the scripts==
First, it is very important that you DUPLICATE the important core scripts. By creating your own scripts, you won't have to worry about screwing the official campaign or other modules.

The scripts that must be duplicated for this tutorial:
- module_core
- sys_chargen_h
- sys_chargen

If you already have duplicates of these for other systems/tutorials (such as the background tutorial), make your edits in those files.

When you duplicate the files, make sure that the names are unique while still naming their purpose for easy editing. For example, you might add a module-specific prefix:
- scar_module_core
- scar_sys_chargen_h
- scar_sys_chargen

==Editing the sys_chargen_h file==
The first thing you want to do is avoid duplicate functions, as this confuses the compiler. You won't need or want to edit every function, so at the top of the file place another include:

#include "sys_chargen_h"

For this tutorial, you can delete everything except the "Chargen_InitializeCharacter" function. (Leave any functions that you may have edited, but don't forget to integrate them when necessary.)

Next you need to create a new name for this function. I suggest the prefix you used for the script files:

scar_Chargen_InitializeCharacter

Near the top of the function you should see a group of lines that look like this:

// -------------------------------------------------------------------------
// 2. Set Creature to Level and Experience 0
// -------------------------------------------------------------------------
SetCreatureProperty(oChar,PROPERTY_SIMPLE_LEVEL,1.0f,PROPERTY_VALUE_BASE);
SetCreatureProperty(oChar,PROPERTY_SIMPLE_EXPERIENCE,0.0f,PROPERTY_VALUE_BASE);

Set the level and XP to the appropriate values for your starting level. (You can give less XP, forcing a character to gain that extra XP before leveling. This does not affect companions.)

You also need to find this group:

// -------------------------------------------------------------------------
// 6. Set up points available to distribute (skills only on humanoids)
// -------------------------------------------------------------------------
if (IsHumanoid(oChar))
{
SetCreatureProperty(oChar,PROPERTY_SIMPLE_SKILL_POINTS, 1.0, PROPERTY_VALUE_BASE);
}
SetCreatureProperty(oChar,PROPERTY_SIMPLE_ATTRIBUTE_POINTS, 5.0, PROPERTY_VALUE_BASE);
SetCreatureProperty(oChar,PROPERTY_SIMPLE_TALENT_POINTS, 2.0, PROPERTY_VALUE_BASE);

And set the values to the appropriate level (or give more/less that usual for certain modules.)

==Editing the sys_chargen file==
Now that the include file is created, open the sys_chargen file. Make sure that you have both chargen includes. For example:

#include "sys_chargen_h"
#include "scar_sys_chargen_h"

This will keep normal functions from breaking.

Find and replace all "Chargen_InitializeCharacter" functions with your custom function. This will start your character at the appropriate level.

There is a bug that occurs during "Quick-Start" unless another step is taken. Find all instances of "AL_DoAutoLevelUp". (There should be two in an unedited file.)

The function that causes the problem looks like this:

AL_DoAutoLevelUp(oChar, TRUE, TRUE);

Either set both trues to falses or copy/paste the other function to this space.

==Editing the module_core==
The home stretch. Now we have to associate the module chargen script with our custom script.

Near the bottom of an unedited script, you should find:

// -----------------------------------------------------------------
// Handle character generation events sent by the engine.
// -----------------------------------------------------------------
if ((nEvent >= EVENT_TYPE_CHARGEN_START && nEvent <= EVENT_TYPE_CHARGEN_END) || nEvent == EVENT_TYPE_PLAYERLEVELUP )
{
HandleEvent(ev, R"sys_chargen.ncs");
}

Switch the script handling the event to your custom script.

==Calling the custom module script==
For those who don't know, a module script now must be associated with the module itself. This is done through [File->Manage Modules->Poperties]. Make sure you have your module selected before you hit properties.

Underneath the module name, there should be a parameter named "Script". Enter the browser and select your custom module_core script. Once you're finished eidting the module, click OK.

==Final steps==
Unless you already have the function in your module_core, you need to actually run character generation.

Under "EVENT_TYPE_MODULE_START", add these lines:

PreloadCharGen();
StartCharGen(GetHero());

==Export and Test==
Make sure you save each file along the way, and compile all scripts once finished. Export the scripts and play your module. You should begin character generation at the appropriate level.

← Older revision		Revision as of 17:48, 23 December 2010
Line 88:		Line 88:

	Switch the script handling the event to your custom script.		Switch the script handling the event to your custom script.
		+
		+	Edit: To avoid confusion, the file that should be edited here is your CUSTOM module_core (thanks for pointing that out below, Gaxkang55.) NEVER edit the core scripts, almost anything that you may need to do can be done with custom duplicates.
		+
	===An alternative view===		===An alternative view===

@@ Line 90: / Line 90: @@
 ===An alternative view===
-Editing the module_core script is almost certainly a bad idea. This code should be placed in your own module script (see next section), with appropriate modification (depending on how you have defined your event variables in that script). For example, if your module script initialisations are:
+Editing the module_core script is almost certainly a bad idea, and is probably not even what was intended. But to be crystal clear, this code should be placed in your own module script (see next section), with appropriate modification (depending on how you have defined your event variables in that script). For example, if your module script initialisations are:
      <dascript>event ev = GetCurrentEvent();
      int nEventType = GetEventType(ev);

← Older revision		Revision as of 09:39, 22 December 2010
Line 88:		Line 88:

	Switch the script handling the event to your custom script.		Switch the script handling the event to your custom script.
		+	===An alternative view===
		+
		+	Editing the module_core script is almost certainly a bad idea. This code should be placed in your own module script (see next section), with appropriate modification (depending on how you have defined your event variables in that script). For example, if your module script initialisations are:
		+	<dascript>event ev = GetCurrentEvent();
		+	int nEventType = GetEventType(ev);
		+	int bEventHandled = FALSE;</dascript>
		+
		+	then you will need:
		+	<dascript>default:
		+	{
		+	if ((nEventType >= EVENT_TYPE_CHARGEN_START && nEventType <= EVENT_TYPE_CHARGEN_END) \|\| nEventType == EVENT_TYPE_PLAYERLEVELUP )
		+	{
		+	HandleEvent(ev, R"scar_sys_chargen.ncs");
		+	bEventHandled = TRUE;
		+	}
		+	break;
		+	}</dascript>

	==Calling the custom module script==		==Calling the custom module script==

← Older revision		Revision as of 18:19, 13 October 2010
Line 1:		Line 1:
	Note: This is a draft. Let me know on the BSN forum thread if these don't work or I'm unclear on what must be done.		Note: This is a draft. Let me know on the BSN forum thread if these don't work or I'm unclear on what must be done.
		+
		+	BSN thread: http://social.bioware.com/forum/1/topic/71/index/5020925

	==Introduction==		==Introduction==

← Older revision	Revision as of 19:11, 13 October 2010
(No difference)