Dragon Age Toolset Wiki - User contributions [en]

Talk:Tutorials

2009-12-30T02:12:01Z

JJM152:

== Restructure ==
I have moved some things around and created some extra categories. First off I reverted the placeable tutorial to its original place in the list. It seems to me that creating an area should take precedence, and you don't need custom placeables in order to do that. I moved the level tutorial down into the more advanced section as that first list was meant to be very introductory. I also split up the other category into different sections. [[User:Stuntpope|Stuntpope]] 01:37, 28 November 2009 (UTC)
:Actually when I moved the level tutorial I assumed it was the old one. I notice the new one is much more introductory, so maybe it could go at the beginning, but I'm still not sure if it isn't too steep a learning curve to start with that. [[User:Stuntpope|Stuntpope]] 03:21, 28 November 2009 (UTC)

I think it could benfit the Layout of the Page if the Video tutorials could be somehow made seperated from the other external tutorials, but i am not sure if its necessary. opinions? --[[User:Alexspeed|Alexspeed]] 09:08, 28 November 2009 (UTC)

People need to be careful about editing links. I had to undo [[User:Darder006|Darder006]]'s edit because he renamed a tutorial link that displeased him and didn't bother to rename the page it pointed to (or copy the content into the new link and orphan the original page). --[[User:JJM152|JJM152]] 02:12, 30 December 2009 (UTC)

Tutorials

2009-12-30T02:08:44Z

JJM152: Undo revision 9084 by Darder006 (Talk)

==Introductory tutorials ==

In the course of these tutorials we'll go through all the steps needed to create a basic adventure.

{{sidebox|
*Boxes like this contain a checklist of important steps.
*They're intended as a reminder and as a navigational aid.
}}

*[[Introductory tutorial]] - An overview of the toolset as a whole
*[[Module tutorial]] - how to create a module to work in.

This set of tutorials forms a series, each building on or filling in omissions by the last:
*[[Area tutorial]]
*[[Placeable tutorial]]
*[[Item tutorial]]
*[[Creature tutorial]]
*[[Conversation tutorial]]

Once you've become familiar with the basics introduced on those tutorials you might have a better grounding for:
*[[Cutscene tutorial]]
*[[Map tutorial]] (which also introduces you to [[2DA]] editing)
*[[Level Editor Tutorial]]
*[[Scripting tutorial]]

== Demo module ==

The toolset currently ships with a simple demo module pre-loaded into its database.

*[[Demo module]] - how to export and run the demo module.

== Custom content tutorials ==
*[[Tutorial: idiots guide to adding custom items to singleplayer]]
*[[Tutorial: Adding a Custom Model to Toolset]]
*[[Tutorial: Creating a custom placeable from a model]]
*[[Tutorial: Reskinning an Item]]
*[[Adding a New Spell Tutorial]]

== Character generation tutorials ==
*[[Backgrounds tutorial]]
*[[Add A New Class Tutorial]]

== Other Tutorials ==
*[[ToolSet: Area Layouts]]
*[[Adding a Location to the Single Player Campaign Tutorial]]

== External Tutorials ==
*[http://lerlek.se/Video+Tutorials Lerlek Dragon Age Origins Toolset Video Tutorials Collection] has collected many in-depth video tutorials.
*[http://dragonagemodding.wordpress.com Beyond Ferelden] has many in-depth tutorials by jwvanderbeck.
*[http://www.youtube.com/watch?v=TwQNRBFLhrE Playable Area and Conversation] video tutorial by [http://social.bioware.com/64020/ st4rdog].
*[http://www.youtube.com/watch?v=CaHldJcUTz8 Simple Conversation Cameras] video tutorial by [http://social.bioware.com/64020/ st4rdog].
*[http://www.youtube.com/watch?v=QOQJ2heQto4 Cutscene and Trigger] video tutorial by [http://social.bioware.com/64020/ st4rdog].
*[http://www.youtube.com/watch?v=szWKgj2ZuXo Custom Level and Room Building] video tutorial by [http://social.bioware.com/64020/ st4rdog].
*[http://www.youtube.com/watch?v=DKJ7F14n8o8 Downloading and Installing the Toolset] video tutorial by [http://social.bioware.com/74287/ DragonAge22].
*[http://www.youtube.com/watch?v=iMPBsulv9xI Creating a Room] video tutorial by [http://social.bioware.com/74287/ DragonAge22].
*[http://www.youtube.com/watch?v=g3kx2CaarHo How to Make an Interior Level with Lighting] video tutorial by [http://social.bioware.com/group/60/ Darkworld Development Team].
*[http://www.youtube.com/watch?v=O6TeZeE1Lc8 Making a Room] video tutorial by BigDrip681.
*[http://social.bioware.com/5339/blog/576/ Custom Player Items In Single Player] by [http://social.bioware.com/5339/ weriK].
*[http://social.bioware.com/5339/blog/651/ The Secret Behind Item Statistics] by [http://social.bioware.com/5339/ weriK].
*[http://social.bioware.com/project/923/ Guide for installing/uninstalling/updating Mods] Beginner Guide to get started with using Mods by [http://social.bioware.com/237411/ Alexspeed].
*[http://www.jezelf.co.uk/tutorials.htm Photoshop Map making tutorials] Credits to Jason Elford, brought to DAT wiki by [http://social.bioware.com/48156/ Arixsus]
*[http://social.bioware.com/project/527/ Video Tutorials by SilentCid] Multiple in-depth video tutorials of the DA Toolset
*[http://www.youtube.com/view_play_list?p=EF29DD1AACEBA92A Qkrch's Video Tutorials] Toolset tutorial complete series for the experienced builder (Spanish & English)
[[Category:Tutorials| ]]

Talk:How-tos

2009-12-23T12:17:01Z

JJM152: /* Scripting Methods... */

the SetCommandable function cite under the "possum" head does not seem to exist. If it does exist, we should provide header for it. -- georage

== How-to's that might be nice to add ==

Add a custom area to the main campaign world map (like how DLC locations are added)

Equip the player with a custom item in the main campaign (see [http://social.bioware.com/5339/blog/576/ http://social.bioware.com/5339/blog/576/] )

[[User:Avantoreon|Avantoreon]] 18:23, 10 November 2009 (UTC)

== Deleting modules from toolset/database ==

Okay, maybe it's just me and however my SQL Server Management Studio Express is set up (default settings), but I found ripping module info out of it nowhere near as easy as the how-to made it sound. I had one module (Demo_1) with two areas; an area transition door/waypoint combo in both areas, a start waypoint and a firepit/sound object in one of the areas.

Followed the instructions to open the Modules table (called dbo.t_Module for me), found the row with Demo_1 on, selected it and pressed delete...wham! Error message effectively saying 'can't delete this, another table refers to it'.

Ookay...so off I go to find that table (dbo.t_ModuleResRef). Sure enough, there's a few rows at the bottom with Demo_1's ID number in the ModuleID column. Fine; select the bottom-most row, pressed delete...wham - again! This row also has another table referring to it.

Off I go again, this time to table dbo.t_ModuleResRefVersion Once more there's a handful of rows at the bottom with Demo_1's ID number in the ModuleID and matching ResRefIDs for the rows in the table before that I'd just tried to delete. By this point I'm actually considering praying before selecting a row and hitting delete... Maybe I should have. Yep, you guessed it - off to find another table.

So this time the table is dbo.t_Placeable, which gives me some hope that maybe, just maybe, this is the end of the reference chain (I prayed, just to be on the safe side!). Not as easy to find what I was looking for, the rows here I had to cross-reference with the ModuleResRefVersion IDs from the previous table - no simple module IDs to help here. Find a row that matches, select, (pray), delete... Success!

Up the table I go, carefully checking ModuleResRefVersion IDs and deleting the rows associated with the module I'm exterminating. Once they're all gone, it's back to the ModuleResRefVersion table itself. Select the row that wouldn't let me delete it before, aaand... another 'can't delete this, another table refers to it' error...

So, in the epically long dbo.t_StringVersion table, seek and destroy all the relevant rows with ModuleResRefVersion IDs that I no longer want...only to find, yep, need to weed them out of dbo.t_StringText first. dbo.t_StringText weeded successfully, I go back to dbo.t_StringVersion and breathe a sigh of relief when that now lets the rows be removed. Take 2 for the ModuleResRefVersion table.

And this time that works as well...to a point. That point being (if you have resource names you can identify easily) where I'd managed to delete all the placeable information and tried to delete the area information. Unsurprisingly (by this point), this sent me off to dbo.t_Area which sent me to dbo.t_AreaInstanceAssociations - I only had one entry in this table, possibly because I'd only created the one module at this point. Back to dbo.t_Area, only to find that I needed to edit dbo.t_AreaWaypoint (3 rows corresponding to each of my 3 waypoints), and then dbo.t_AreaObject which sent me to dbo.t_AreaObjectVariable (4 rows; two for each area transition door). Finally back to dbo.t_Area again aaand, off to dbo.t_AreaSound (the firepit's sound object) - another table with just the one row.

Fiiinally, dbo.t_Area is free of ModuleResRefVersion IDs for my Demo(n) module! Back to the ModuleResRefVersion table and delete the last references in there. Back to the ModuleResRef table and delete all the appropriate module references in there. And finally, finally, back to the table that started it all, the Module table, and delete the module reference in there.

All that, just to delete a basic module consisting of 2 Areas, 2 (transition) Doors, 3 Waypoints, 1 Firepit and 1 Sound Object. Why oh why could there not be a simple 'delete' option for modules within the toolset itself? [[User:ZGold|ZGold]] 10:53, 20 November 2009 (UTC)

: Just to add; I'd already deleted the resources (placeables, areas etc.) from the module in the toolset before I went rooting around in the SQL. [[User:ZGold|ZGold]] 10:55, 20 November 2009 (UTC)

:Hmm oddish. Worked fine for me and I didn't even bother to delete anything. I'll poke around some more. Might be a moot point as I am working on a Stored Procedure to remove all the references. [[User:Languard|Languard]] 14:33, 20 November 2009 (UTC)

:: like I said, it could be something in the default setup of the SQL manager *shrugs* - a couple of additional notes; I found the string editor in the toolset was still refering to a talk table for my deleted module, I had to go back into the SQL and delete the appropriate reference from the dbo.t_String and dbo.t_StringTable tables; also, after the first round of deleting things from the SQL tables when I tried to load the editor it threw up a series of errors - whether that had anything to do with the module I deleted having been the last open (and thus 'open by default') module, or not, I'm not sure, but after agreeing that the toolset could open the default module (single player) and trying to run the editor again, it ran fine. Thought I'd mention that just in case anyone has the same thing happen and panics :P [[User:ZGold|ZGold]] 17:19, 20 November 2009 (UTC)

:: You guys are scaring me. There has to be a better way, doesn't there? --[[User:Adaram|Adaram]] 17:37, 20 November 2009 (UTC)

::: I think (hope!) Languard is working on said better way, but I must admit, I'm very surprised that bioware didn't add a utility for automatically doing this sort of thing. Another thing to watch out for; as I'd exported my demo module there was a 'toolset export' folder (or some similar name) in my override folder that broke the automatic addition of NPCs (Morrigan/Alistair/Dog etc) to my party (in the OC) until I deleted said folder. [[User:ZGold|ZGold]] 10:52, 23 November 2009 (UTC)

== Scripting Methods... ==
Modified the first script example. It was using IsPlayer() instead of IsHero() method call.
--[[User:JJM152|JJM152]] 12:17, 23 December 2009 (UTC)

Talk:How-tos

2009-12-23T12:16:04Z

JJM152: /* Scripting Methods... */ new section

the SetCommandable function cite under the "possum" head does not seem to exist. If it does exist, we should provide header for it. -- georage

== How-to's that might be nice to add ==

Add a custom area to the main campaign world map (like how DLC locations are added)

Equip the player with a custom item in the main campaign (see [http://social.bioware.com/5339/blog/576/ http://social.bioware.com/5339/blog/576/] )

[[User:Avantoreon|Avantoreon]] 18:23, 10 November 2009 (UTC)

== Deleting modules from toolset/database ==

Okay, maybe it's just me and however my SQL Server Management Studio Express is set up (default settings), but I found ripping module info out of it nowhere near as easy as the how-to made it sound. I had one module (Demo_1) with two areas; an area transition door/waypoint combo in both areas, a start waypoint and a firepit/sound object in one of the areas.

Followed the instructions to open the Modules table (called dbo.t_Module for me), found the row with Demo_1 on, selected it and pressed delete...wham! Error message effectively saying 'can't delete this, another table refers to it'.

Ookay...so off I go to find that table (dbo.t_ModuleResRef). Sure enough, there's a few rows at the bottom with Demo_1's ID number in the ModuleID column. Fine; select the bottom-most row, pressed delete...wham - again! This row also has another table referring to it.

Off I go again, this time to table dbo.t_ModuleResRefVersion Once more there's a handful of rows at the bottom with Demo_1's ID number in the ModuleID and matching ResRefIDs for the rows in the table before that I'd just tried to delete. By this point I'm actually considering praying before selecting a row and hitting delete... Maybe I should have. Yep, you guessed it - off to find another table.

So this time the table is dbo.t_Placeable, which gives me some hope that maybe, just maybe, this is the end of the reference chain (I prayed, just to be on the safe side!). Not as easy to find what I was looking for, the rows here I had to cross-reference with the ModuleResRefVersion IDs from the previous table - no simple module IDs to help here. Find a row that matches, select, (pray), delete... Success!

Up the table I go, carefully checking ModuleResRefVersion IDs and deleting the rows associated with the module I'm exterminating. Once they're all gone, it's back to the ModuleResRefVersion table itself. Select the row that wouldn't let me delete it before, aaand... another 'can't delete this, another table refers to it' error...

So, in the epically long dbo.t_StringVersion table, seek and destroy all the relevant rows with ModuleResRefVersion IDs that I no longer want...only to find, yep, need to weed them out of dbo.t_StringText first. dbo.t_StringText weeded successfully, I go back to dbo.t_StringVersion and breathe a sigh of relief when that now lets the rows be removed. Take 2 for the ModuleResRefVersion table.

And this time that works as well...to a point. That point being (if you have resource names you can identify easily) where I'd managed to delete all the placeable information and tried to delete the area information. Unsurprisingly (by this point), this sent me off to dbo.t_Area which sent me to dbo.t_AreaInstanceAssociations - I only had one entry in this table, possibly because I'd only created the one module at this point. Back to dbo.t_Area, only to find that I needed to edit dbo.t_AreaWaypoint (3 rows corresponding to each of my 3 waypoints), and then dbo.t_AreaObject which sent me to dbo.t_AreaObjectVariable (4 rows; two for each area transition door). Finally back to dbo.t_Area again aaand, off to dbo.t_AreaSound (the firepit's sound object) - another table with just the one row.

Fiiinally, dbo.t_Area is free of ModuleResRefVersion IDs for my Demo(n) module! Back to the ModuleResRefVersion table and delete the last references in there. Back to the ModuleResRef table and delete all the appropriate module references in there. And finally, finally, back to the table that started it all, the Module table, and delete the module reference in there.

All that, just to delete a basic module consisting of 2 Areas, 2 (transition) Doors, 3 Waypoints, 1 Firepit and 1 Sound Object. Why oh why could there not be a simple 'delete' option for modules within the toolset itself? [[User:ZGold|ZGold]] 10:53, 20 November 2009 (UTC)

: Just to add; I'd already deleted the resources (placeables, areas etc.) from the module in the toolset before I went rooting around in the SQL. [[User:ZGold|ZGold]] 10:55, 20 November 2009 (UTC)

:Hmm oddish. Worked fine for me and I didn't even bother to delete anything. I'll poke around some more. Might be a moot point as I am working on a Stored Procedure to remove all the references. [[User:Languard|Languard]] 14:33, 20 November 2009 (UTC)

:: like I said, it could be something in the default setup of the SQL manager *shrugs* - a couple of additional notes; I found the string editor in the toolset was still refering to a talk table for my deleted module, I had to go back into the SQL and delete the appropriate reference from the dbo.t_String and dbo.t_StringTable tables; also, after the first round of deleting things from the SQL tables when I tried to load the editor it threw up a series of errors - whether that had anything to do with the module I deleted having been the last open (and thus 'open by default') module, or not, I'm not sure, but after agreeing that the toolset could open the default module (single player) and trying to run the editor again, it ran fine. Thought I'd mention that just in case anyone has the same thing happen and panics :P [[User:ZGold|ZGold]] 17:19, 20 November 2009 (UTC)

:: You guys are scaring me. There has to be a better way, doesn't there? --[[User:Adaram|Adaram]] 17:37, 20 November 2009 (UTC)

::: I think (hope!) Languard is working on said better way, but I must admit, I'm very surprised that bioware didn't add a utility for automatically doing this sort of thing. Another thing to watch out for; as I'd exported my demo module there was a 'toolset export' folder (or some similar name) in my override folder that broke the automatic addition of NPCs (Morrigan/Alistair/Dog etc) to my party (in the OC) until I deleted said folder. [[User:ZGold|ZGold]] 10:52, 23 November 2009 (UTC)

== Scripting Methods... ==

Someone might want to verify that the code samples on this page actually work. I fixed one already that called a non-existent function :)

How-tos

2009-12-23T12:13:01Z

JJM152: /* Run a cutscene from a trigger */

This page lists how to accomplish tasks that are relatively simple and commonly needed, but that touch on multiple areas of the toolset or are difficult to figure out intuitively how to do.

Just collecting ideas at the moment, add headers if you think a how-to is needed on a particular subject.

*[[3D control]]

== Run a cutscene from a trigger ==

!!compile fails in test database due to bad core libraries, so this hasn't been tested!!

Create a script:

<dascript>
#include "events_h"
#include "global_objects_h"
#include "utility_h"

void main ()
{
event ev = GetCurrentEvent();
int nEventType = GetEventType(ev);
int nEventHandled = FALSE;
switch (nEventType)
{
case EVENT_TYPE_ENTER:
{
object oCreature = GetEventCreator(ev);
if(IsHero(oCreature)) {
resource rCutscene = R"my_cutscene.cut";
CS_LoadCutscene(rCutscene);
DestroyObject(OBJECT_SELF, 0);
}
break;
}
if (!nEventHandled) //If this event wasn't handled by this script, let the core script try
{
HandleEvent(ev, RESOURCE_SCRIPT_TRIGGER_CORE);
}
}
</dascript>

And set it as the event script for the trigger that you want to have run the cutscene.

== Add a follower to the player's party ==

<dascript>
if(IsPlayer(oCreature)) {
object oFollower = GetObjectByTag("myfollower");
UT_HireFollower(oCreature, oFollower);
}
</dascript>

Note that with Toolset v1.0.982.0, calling UT_HireFollower() will result in a follower who's unable to gain xp. This happens due to the call of
WR_SetFollowerState(oFollower, FOLLOWER_STATE_ACTIVE, TRUE, 0, '''TRUE''');
to the function
void WR_SetFollowerState(object oCreature, int nState, int nSendEvent = TRUE, int nMinLevel = 0, '''int bPreventLevelup''' = FALSE)
To enable the xp gain, the flag CREATURE_REWARD_FLAGS needs to be cleared from the follower after the hired event was processed (there the flag is set). Alternatively, the relevant contents of UT_HireFollower() are to be called directly using bPreventLevelup = FALSE.

== Have an enemy play possum and then get up to fight ==

Set the creature's CREATURE_SPAWN_DEAD variable to 2.

When it's time for the creature to rise and attack, execute the following script commands:

<dascript>
#include "wrappers_h"
...
WR_SetObjectActive(oCreature, TRUE);
SetCommandable(oCreature, TRUE);
// Make sure to set this flag back to 0 to avoid problems with savegames.
SetLocalInt(oCreature, CREATURE_SPAWN_DEAD, 0);
UT_CombatStart(oCreature, oPC);
</dascript>

== Insert content into an existing area ==

If you want to add new content on to an existing area (for example, putting a new character or area transition door into an area that exists in the single-player campaign) there are two different ways to do it. One is to override the existing area with a new area of your own design that duplicates the original with the exception of your additions. This is straightforward to do but can interact poorly with other add-ons - you can only have one version of an area active at a time.

A more elegant and extensible approach is to use a [[PRCSCR]]_-prefixed M2DA. The PRCSCR M2DA has a very simple structure and a simple but profound effect:

*ID - a unique integer identifier for each row
*AreaListName - a string that identifies a specific area list, or the special keyword "any".
*Script - the name of a script file.

Whenever a player enters an area in an area list in this M2DA the associated script will be run. A modder can therefore include a script with his mod that will be run when the player enters an existing area that he didn't create. This script can freely add or remove placeables and creatures and perform whatever other modifications to the area that a script is capable of doing.

Note that the script will be run every time the player enters the area, so you'll want to have an associated plot flag to ensure that the changes are only made once.

The following example is a script that adds a new character from an add-on module to an existing area in the main game:

<dascript>
void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag("joblos_quest", JOBLO_ADDED_TO_TOWN) == FALSE)
{
object oTown = GetObjectByTag("lot100ar_lothering"); //An area's tag is the same as its resource name
vector vJobloLocation = Vector(126.745f,120.724f,0.460568f); // See below for how to get these coordinates

CreateObject(
OBJECT_TYPE_CREATURE,
R"joblo.utc",
Location(oTown, vJobloLocation, 180.0f) //See below for how to get the value for orientation
)

WR_SetPlotFlag("joblos_quest", JOBLO_ADDED_TO_TOWN, TRUE);
}
}
</dascript>

Since you can't add [[waypoint]]s to an existing area you'll need to enter the position and orientation values for the target location manually. You can find them by creating a local copy of the area in question and temporarily adding a waypoint to copy down the coordinates and orientation you'll need.

== Add new music ==

Open up [[FMOD]]

It creates a project - set the build directory to your DA override directory - with project highlighted, it is over on the top right about half way down the project settings. You can set a default resource directory but that will just set where the file browser defaults to so it is optional. I'd also define a name in those parameters while you are there.

From there, you need a new event !!(not sure whether a blank default is generated or whether you have to right click and make a default blank event)!!. After you have an event, highlight it and change to the event tab (2nd tab). Here you need to import your file to link to that event.

On that tab I think it creates a empty row for your new event - right click and add wavetable or something like that - I think I use the top option. (Again, might be wrong but the basic goal is getting a audio file in that screen that plays when you hit the play button at the top)

Browse to your wav file or whatever you have.

From there you should be able to play the sound both in the pop-up box and (once that is closed) back in the event tab. You'll see the name of the wave in that once empty row (IIRC).

If you want, you can add layers of sounds to this event using the same process over and over, but keeping it simple; we'll just move along.

Now you have a project and an event. You can set various parameters on the first tab that alter pitch etc on the first tab. (When you import the sound, you set whether it is a one shot or looping).

Once you have that done, go to the top drop down and find build. Build the files and you should see extra files in your override directory.

From there, just open up the toolset (or hit refresh from within the toolset) and your project and event sounds should show up in the listing of sounds.

You can then drag and drop them into the game or cutscene and they will play.

== Adding music to cutscenes ==

The way we have been doing the music changes is via placed sound objects. These sound objects are generally created in [[FMOD]], and in FMOD you can say if the music will persist after the cutscene or end when the cutscene ends.

We are just using other sounds to switch music tracks. Designers can add music switch parameter to any sound in Fmod Designer, usually this is just VO line to change music track, for example:

[[Image:FMOD music switch.jpg]]

If there are no other sounds, designers can create empty sound event and add #music parameter there and place this sound on cutscene timeline.
Music track has to be defined in the same group as music in current area in “music.fdp” to work.

[[Image:FMOD music switch 2.jpg]]

<pre>
#music:name,1 – non looping, for stingers
#music:name – for looping music
</pre>

== Delete resources ==

Resource deletion can sometimes be a bit complicated. Check the following:

*Resources must be checked in when deleted. This is so that the toolset can be sure that all dependencies have been properly resolved.
*If other resources reference the resource it can't be deleted. This means that sometimes you'll need to delete resources in a specific order. For example, you can't delete a creature that's being used in an area, but you could delete the area and then delete the creature. Occasionally there may be circular references that you'll need to break by editing the resources before deleting them. For example:
**A stage can reference an area, which can then reference the stage.
**A plot file can have an associated event script, which will almost certainly include the plot file.
**A stage can reference a creature, which references a dialogue, which references the original stage.

== Removing Modules ==

Deleting a Module from the Toolset
Setup:
I created a module called Meep with a unique id of rcfMeep, added in one area with a waypoint, configured the starting area/waypoint info, and exported it with dependencies. And now I want to strip it out.

Step 1: Removing it from the game

* Navigate to My Documents\Bioware\AddIns
* Delete the folder called rcfMeep
* Done

Removing from the game is fairly easy. The toolset? Not so much. The reason for this is that the information is stored in the SQL Database. Now if you just want to remove the module from the Manage Modules list, that is easy.

* Open Sql Server Management Studio Express. I'm not sure if the default installation installs this or not. If not, it can be downloaded from Microsoft.
* Connect to the BWDATOOLSET server, assuming that you kept the default options.
* Expand Databases
* Expand bw_dragonage_content
* Expand Tables
* Right click and select open on the dbo.Modules table
* This will bring up an excell-like window. Find your module, right-click on the row, and select delete. Say ok to the confirmation.
* Module is now PERMANENTLY removed. Absolutely no way of recovering it.

Now depending on the size of the Module, you just orphaned a bunch of resources. Areas, placables, conversations, they all get placed into the database. And once you remove the module ID, you just lost your ability to remove these resources. Now do keep in mind that 95% of this junk is just text, so it hardly takes up any room. It's not really a major issue. However if you [[How-tos#Delete resources|delete out the resources]] within the toolset before you remove the module reference you should avoid this.

== Override Events (e.g. those in player_core) ==
Look here: [[Event override]]

== Create a lootable placeable that vanishes when looted ==

For a player-usable placeable, use the following event script to make it give its contents to the player and then vanish when clicked on.

<dascript>
#include "wrappers_h"
void main()
{
event ev = GetCurrentEvent();
int nEventType = GetEventType(ev);
switch (nEventType)
{
case EVENT_TYPE_USE:
{
//MoveAllItems(OBJECT_SELF, GetHero());
AddCreatureMoney (1000000, GetHero(), TRUE);
Safe_Destroy_Object(OBJECT_SELF);
}
}
}
</dascript>

If you wanted to use standard resources you could achieve the same thing (though not destroying the placeable) simply by adding "_autoloot" to the end of the placeable's tag.

== Move the player to a new area after a cutscene plays ==

Stand-alone cutscenes have an "end script" parameter that sets a script to run once the cutscene ends. Use a script such as the following:

<dascript>
void main()
{
DoAreaTransition("destination_area_tag", "destination_waypoint_tag");
}
</dascript>

Talk:Treasure system

2009-12-20T05:00:35Z

JJM152: Created page with 'I modified the table in regards to "TS_OVERRIDE_EQUIPMENT_CHANCE". This value is actually a percent chance of any particular piece of equipped gear dropping. Furthermore, if you ...'

I modified the table in regards to "TS_OVERRIDE_EQUIPMENT_CHANCE". This value is actually a percent chance of any particular piece of equipped gear dropping. Furthermore, if you leave it at 0.0, then the stupid treasure system pulls a default value out of the AUTOSCALE table.
--[[User:JJM152|JJM152]] 05:00, 20 December 2009 (UTC)

Treasure system

2009-12-20T04:58:31Z

JJM152: /* Overrides */

The Treasure System only works on creatures and placeable containers (not bags). Creatures will fire the Treasure System when they die, and placeables will fire it when they spawn.

There are 2 specific pieces of information that the Treasure System uses to determine what treasure an object drops. The first piece of information is the combat Rank of the object. Placeables are never involved in combat, but will have to have something entered in the field for the system to work. A Lieutenant-ranked chest will drop treasure equivalent to a Lieutenant-ranked creature. Rank determines the quantity and quality of the treasure dropped. The second piece of information is the Treasure Category of the object. This determines what set of treasure tables the system will look at for this object.

If either the Rank or Treasure Category is set to Invalid (value 0), the Treasure System will not drop anything. Items placed manually on the object will appear normally.

If there doesn't seem to be a treasure table that applies to a specific object, contact the designer in charge of the system to get a new table added.

== Overrides ==

There are a number of override variables on objects that will change the way the Treasure System functions. For each of these variables, a value less than 0 turns off that part of the system, a value of 0 ignores the override, and a value greater than 0 uses that value instead of the one on the creature. Each variable has a short explanation of what overriding does.

{{variable table start}}
{{variable table row|TS_OVERRIDE_CATEGORY |int|0| A value here directly relates to ID values in the TS_Category 2DA.}}
{{variable table row|TS_OVERRIDE_EQUIPMENT |float|0| A value here determines the chance of any particular piece of equipped items dropping. Set this to a negative number to prevent the treasure system from using the default value from the auto scaling table.}}
{{variable table row|TS_OVERRIDE_HIGH|float|0| high chance }}
{{variable table row|TS_OVERRIDE_ITEM|float|0| item chance }}
{{variable table row|TS_OVERRIDE_MONEY |int|0| A value here overrides the TS_MoneyValue value in the autoscale 2DA.}}
{{variable table row|TS_OVERRIDE_RANK |int|0| A value here directly relates to ID values in the autoscale 2DA.}}
{{variable table row|TS_OVERRIDE_REACTIVE|float|0|Reactive chance, only present in the creature variable table{{undocumented}} }}
{{variable table row|TS_OVERRIDE_SCALING |int|0| A value here has no additional effect. This is currently only useful to turn off scaling.}}
{{variable table row|TS_OVERRIDE_STEALING |int|0| A value here directly relates to ID values in the TS_Stealing 2DA.}}
{{variable table end}}

== Stealing ==

Stealing from a creature functions the same as a normal treasure drop, except the loot is only ever a single Minor Item. No Money or Major Items will be dropped.

The TS_OVERRIDE_STEALING variable allows special functionality to be added when a creature is stolen from. A value placed in the override is actually an ID lookup in the TS_Stealing 2DA. When that creature is stolen from (and a creature can normally only be successfully stolen from once), it gets the item resource referenced by that ID and adds it to the treasure gained from stealing.

Stealing from creatures is mostly handled by systems, so there are only a couple places a designer can interact with it. First it will be useful to describe exactly what happens when the Stealing skill is used.

When a character tries to use Stealing on another creature, it checks a variety of factors on the character and the target to determine success. If the target has already been stolen from, the character neither succeeds nor fails. If the character fails, the [[EVENT_TYPE_STEALING_FAILURE]] event is fired on the current area. If the character succeeds, the [[EVENT_TYPE_STEALING_SUCCESS]] event is fired on the current area and the FLAG_STOLEN_FROM variable on the target is set to TRUE. Additionally, a successful use of the Stealing skill causes the Treasure System to generate a single Minor Item on the character using the skill. This requires the target to be properly set up for the Treasure System.

The [[EVENT_TYPE_STEALING_FAILURE]] and [[EVENT_TYPE_STEALING_SUCCESS]] events are intended for use in the Infamy system and will be used in the Stealing Reactivity pass.

The FLAG_STOLEN_FROM variable can be set on a creature manually to allow them to be immune to stealing attempts. This can be used to shield plot characters from the skill, though Stealing won't actually remove any items from their inventory. Additionally, you can set the flag to FALSE through scripting to allow the player to steal from a target more than once. Creatures with this flag set will not fire [[EVENT_TYPE_STEALING_FAILURE]] or [[EVENT_TYPE_STEALING_SUCCESS]] events, so they won't interact with the Infamy system.

=== Specific Items ===

The Treasure System has functionality added to allow you to get specific items when stealing from a character. The TS_OVERRIDE_STEALING variable on creatures allows you to set associate a creature with a specific ID value in the TS_Stealing 2DA. Each ID value references a specific item resource name. When a character with this variable set is stolen from, that specific item resource will be added to the treasure the player receives.

The target does not have to have a valid Rank or Treasure Category for this item to drop. This is so you can drop only the specific item and nothing else.

== TS_System.xls and related 2das ==

See [[TS_System.xls]]

[[Category:Creatures]]
[[Category:Placeables]]

User:JJM152

2009-12-14T15:03:54Z

JJM152: Created page with 'Hi there. I promise to put something interesting here when I get a chance! --~~~~'

Hi there. I promise to put something interesting here when I get a chance!

--[[User:JJM152|JJM152]] 15:03, 14 December 2009 (UTC)

Talk:Item properties

2009-12-14T03:04:39Z

JJM152:

I broke this out of the main [[Item]] page because it probably deserves to have a little bit more elaboration.

I've gone ahead and enumerated the contents of the itemprps 2da with a little clarification from Craig Graff, but hopefully either Mr. Graff or someone else with more knowledge than I will come along and verify everything.

Also, I think an explanation of how itemprps.xls, effects.xls and properties.xls link together is warranted here.

--[[User:JJM152|JJM152]] 03:04, 14 December 2009 (UTC)

Talk:Item properties

2009-12-14T03:04:22Z

JJM152: Created page with 'I broke this out of the main Item page because it probably deserves to have a little bit more elaboration. I've gone ahead and enumerated the contents of the itemprps 2da w...'

Item

2009-12-14T02:59:53Z

JJM152: /* Item Properties */

An item is a game object that can be picked up or equipped by a creature. Dragon Age will have many items. As the player gains levels he or she will encounter progressively more powerful items. Through the use of material types (unique models and/or color variation) we will scale our items so that we have a greater range of item diversity than in our previous games.

Items are grouped into types called "Base Item Types". The item's base type determines how it can be used and what its basic properties are.

Some examples of base item types are:
* Sword
* Bow
* Arrows
* Helmet
* Potion

Weapon and armour items get their basic ratings from their base item type. This is further modified by the material type of the item (i.e., high steel sword vs. low steel sword) and other item properties on them.

Unlike in Neverwinter Nights, items can't be placed on the floor. They can only be stored in an inventory of some kind.

==== Item Attributes ====

Item's attributes are determined in part by their base type and can be customized further in the toolset. They can be further modified in the game by applying item properties.

==== Appearance ====

An item's appearance will be determined by their base type and an appearance field. A base item 2da and an item appearances 2da controls the different appearances for each base type. The number of appearance variations for each base type will vary. Visual effect item properties can be applied later to further modify the appearance of the item (flame effects, etc…)

==== Icons ====

Each item's icon has a width and height. This size corresponds roughly to the size of the item in the world, so small potions will have a small icon and large suits of armour will take up more space.

We don't track the weight of items because of the shared party inventory. Some items will have properties on them that will require the creature to have certain minimum attributes to equip them though. This will simulate particularly heavy armour or weapons.

==== Stacks ====

Each item can have a stack size on them. This means that the item actually represents a pile of identical items. Stacks can be split into new items or merged to destroy old ones. Only items that have identical types and properties can be merged into stacks.

==== Cost ====

An item's cost will be set in a field by either the toolset or the scripting language. There won't be any automatic cost calculation done.

==== Plot Items ====

Some items will be flagged as "plot" items. This means the item is important to some plot in the game and should be treated differently. When the player picks up one of these items they will appear on a special plot page in their inventory. Plot items can’t be sold in stores or destroyed through normal game-play.

==== Indestructible items ====

These are items that are needed for the plot, but can still be used or equipped by the player. The use of this flag is very restricted and it should be used only when no other solution will work. Items with this flag can not be destroyed, sold or given to another character to equip.

==== Item Scripts ====

Items will have AI scripts associated with them like any other game object (the script is attached to the item). They will receive and process events in much the same way (acquire, lose, equip, unequip, etc…)

==== Item Equipping ====

All base item types are limited by attribute Strength (except wands which are Magic limited). An item cannot be equipped unless its base item attribute requirements are met. The reasons why an item cannot be equipped will be clearly indicated by the GUI.
Almost all items can be equipped and unequipped by a player during combat. The only exception is armor. Armor cannot be equipped or unequipped if the character is within sight of an enemy creature.

==== Dropping Items ====

* Players will not be allowed to drop items into the world or into containers by default. Specific containers can be set to accept items.
* If a creature dies the items are dropped into a bodybag

==== Item Scaling ====

The item system needs to be very robust, allowing for a wide diversity of item types, item appearances within a type, and rules scaling. Material types are the primary mechanism for item scaling... i.e., we won't randomize the type of item in many cases (flaming sword) but we will randomize its material type (low steel flaming sword vs. high steel flaming sword)

==== Activated Items ====

Each item can have a single default action. This is entered by picking an ability of type "Item Ability" from the abilities table which defines its icon, script, description and targetting behaviour. Items that can be used go into a special equip slot. All other item types (weapons, armor, et cetera) cannot have a custom item use.
The number of uses for this ability will be decided by the script which will destroy the item when appropriate.
* there are no uses per day type items. All items only have "number of uses".

==== Descriptions ====

Item descriptions will be primarily autogenerated with stat information.
There will also be a text description but few items will have descriptions written for them. A subset list of all the items (the really powerful ones, crafting items, and plot items) will be the only ones with descriptions.

==== Further Details ====

* Equippable Items
** Melee Weapons
*** Some weapons are one handed, can be used with a shield
*** Some weapons are two handed
*** Daggers and Longswords can be dual wielded
** Ranged Weapons
*** Can use special ammunition, if you have it. Otherwise they can fire a "default" ammo type.
** Shields
** Paperdoll items (i.e., helmets, gloves, et cetera)
* Unequipped items
** There are a large variety of items that cannot be equipped on the ingame avatar. Some of these can be placed on the quickbar (i.e., potions) if they have activated item abilities
* Items can be upgraded (i.e., adding fire damage to a sword).
* Items can be crafted from other item parts
* Items can have Item properties

==== Tools ====

Items are created in the Designer Toolset using the Object Inspector Editor. Once created, item can be given as inventory to creatures and placeables. Once placed, both the creature/placeable and the item must be exported in order to be viewed in the game. Exporting happens automatically or can be done manually by the designer during testing.

=== Inventory slots ===

{|
|-
! Slot || Item type || Visible on avatar?
|-
| Right Hand || Weapons || Yes
|-
| Left Hand || Weapons, Shields || Yes
|-
| Head || Helmet || Yes
|-
| Chest || Armor, Clothing || Yes
|-
| Waist || Belt, Girdle || No
|-
| Quick Items || Useable Items || No
|-
| Right Fingers || Ring || No
|-
| Left Fingers || Ring || No
|-
| Feet || Boots || Yes
|-
| Neck || Amulets || No
|-
| Hands || Gloves || Yes
|-
| Inventory - Normal || Backpack Items || No
|-
| Inventory - Plot || Plot Items || No
|}

== Item Properties ==

See [[Item properties]] for more information.

== Item Abilities ==

Item Abilities are activated abilities on items (for example, a potion with the activated ability Healing is a Potion of Healing). An item can only have one item ability. This item ability is assigned in the toolset.
They are not item properties.

=== Detailed Description ===

Item abilities cannot be placed on equippable items.

Item abilities are activated by right-clicking or double-clicking the item or from using the item from the quickbar

== Variables ==

{{variable table start}}
{{variable table row|APP_ITEM_MOTIVATION | int |0| }}
{{variable table row|ITEM_CODEX_FLAG | int |-1| when != -1, this will be the codex plot flag to set for this item when acquired. The plot name is the tag of the item}}
{{variable table row|ITEM_COUNTER_1 to 2 | int |0| }}
{{variable table row|ITEM_CRUST | int |0| }}
{{variable table row|ITEM_DO_ONCE_A and B | int |0| }}
{{variable table row|ITEM_SEND_ACQUIRED_EVENT | int |0| when true, [[EVENT_TYPE_CAMPAIGN_ITEM_ACQUIRED]] is sent to the module's event script when the item is aquired. }}
{{variable table row|ITEM_SET | int |-1| Certain items will give a bonus when equipped with other members of the same set (as identified by this integer).}}
{{variable table row|ITEM_SPECIALIZATION_FLAG| int|0|}}
{{variable table row|ITEM_SEND_LOST_EVENT| int| 0 | }}
{{variable table row|PROJECTILE_OVERRIDE|int|0|}}
{{variable table row|ITEM_RUNE_ENABLED|int|0|}}
{{variable table end}}

== Properties ==

{{inspector start}}
{{inspector section|General}}
{{inspector row|Activated Ability| Action happening on a specific event related to the item (hit with weapon, being hit on armor, etc.)}}
{{inspector row|Base Item Type| The inventory type of the item. Also gives the base appearance type for the item. }}
{{inspector row|Comments| General information about the item }}
{{inspector row|Crafting Recipe Type| The type of recipe this is. From recipes 2da. }}
{{inspector row|Description| }}
{{inspector row|DescriptionRequiresReTranslation| }}
{{inspector row|Heraldry| }}
{{inspector row|Icon| }}
{{inspector row|Item Variation| An appearance variation based on the base item type. }}
{{inspector row|MaterialProgression| }}
{{inspector row|MaterialType| }}
{{inspector row|Name| }}
{{inspector row|NameRequiresReTranslation| }}
{{inspector row|Resource Name| A unique string identifier the toolset and the game both use to refer to this resource}}
{{inspector row|Tag| A non-unique string identifier used mostly by scripts and other resources to refer to this resource. }}
{{inspector row|Tint Override| }}

{{inspector section|Attributes}}
{{inspector row|Body Tint| Affects the appearance of item wearer. Typically used to customize the Dog's warpaint. }}
{{inspector row|Body Tint Mask| Affects the appearance of item wearer. Typically used to customize the Dog's warpaint. }}
{{inspector row|Cost| Base money value of the item. }}
{{inspector row|Damaged| }}
{{inspector row|Item Properties| Allows selecting one or more item properties for the item. Item Properties are any special power, effects, or stat variations beyond the basic item attributes. Properties also includes restrictions by class, race, etc. }}
{{inspector row|OnHit Effect| }}
{{inspector row|OnHit Power| }}
{{inspector row|Plot Item| A plot item can not be destroyed or removed from inventory by the player once the player has acquired it. Plot items can only be removed via scripts written by the designer.}}
{{inspector row|Script| Event script assigned to the resource }}
{{inspector row|Unique| }}
{{inspector row|Variable 2da| 2da file containing a variable table. Only the values in the table can be set and retrieved by scripting. }}
{{inspector row|Variables| Opens the variable table for editing, allows the initial values of the variables to be defined.}}

{{inspector section|Model Appearance (R/O)}}
{{inspector row|Model Appearance| }}
{{inspector row|Model Gender| }}
{{inspector end}}

[[Category:Items]]

Item properties

2009-12-14T02:58:03Z

JJM152: Created page with '== Item Properties == An item property is a modifier on an item similar to an effect. These modifiers affect either the item itself or the item's wielder. Item properties (i.e...'

== Item Properties ==

An item property is a modifier on an item similar to an effect. These modifiers affect either the item itself or the item's wielder.

Item properties (i.e., fire damage) are assignable in the toolset and via scripting
* Scripting functions to add properties
* Scripting functions to remove properties
* Toolset can add/remove properties
* Item Abilities are not item properties

MAKE is an item property. Because Dragon Age is a low magical world we cannot flood the player with magical items. However item progression is important to a RPG. We have decided to use an item progression system whereby items get better depending on the materials and processes used in their construction. In Dragon Age each weapon, armor, and shield progresses through several levels of quality. The highest quality items are more powerful and harder to obtain. These quality levels are called makes (they used to be called material types).

As MAKE improves, it:
*increases the base statistics for a particular item (attack rating, damage and armor penetration for weapons, armor rating for armor, defense rating for shields).
*changes the physical appearance of an item. Generally this change should be a model change though for expansion purposes we may also insert additional makes that are merely color changes.
*Determines the number of upgrade/enchantment slots that are available on the item

The values in the 2DA MaterialTypes.2da influence the initial damage, attack bonus, armor penetration, defense and armor of an item. There are several upgrade stages for each equipped item. All items follow the same progression, but the labels used to refer to this progression changes based on the item type. The item's progression dictates the number of enchantment rune upgrades it can support.

Each base item type has its own list of material types, with different numbers. However many base items do share material types, so we can group them into Melee Weapons, Ranged Weapons, Wands, Armor, Shields, Helmets, etc.

The item properties allowed to be assigned to an item are based on the item's base types (i.e., a longsword has different properties allowable than a suit of armor)

When an item is equipped or un-equipped, a call-back function is run for each property on it. These usually apply or remove some package of effects with the duration type "Equipped". These are used to create items that grant bonuses when used.

=== List of Item Properties ===

Item Properties can be added either directly to an item through the tool builder interface, or assigned via scripting through the [[AddItemProperty]] method.

{{2da start
|name=itemprps.xls}}
{{2da column
|name= LABEL
|type= string
|description= Name of the property
}}
{{2da column
|name= NameStrId
|type= int
|description= Reference to the Name String for the property.
}}
{{2da column
|name= IPType
|type= int
|description= The Type of the property. 1 = effect, 2 = onhit, 3 = restriction, 4 = special.
}}
{{2da column
|name= effect
|type= int
|description= Reference to the effect this property invokes. See effects.xls (1012 references: EFFECT_TYPE_MODIFY_PROPERTY)
}}
{{2da column
|name= int0
|type= int
|description= A possible argument passed to the effect. For EFFECT_TYPE_MODIFY_PROPERTY this points to an ID row inside properties.xls
}}
{{2da column
|name= int1
|type= int
|description= A possible argument passed to the effect.
}}
{{2da column
|name= float0
|type= float
|description= A possible argument passed to the effect. For EFFECT_TYPE_MODIFY_PROPERTY this is the amount of effect to apply per point of power.
}}
{{2da column
|name= float1
|type= float
|description= A possible argument passed to the effect.
}}
{{2da column
|name= ConditionScript
|type= float
|description= A script reference. Used to restrict equipping items when IPType is set to 3. (See \_Global\Item Scripts\ in the single player campaign for examples of the scripts).
}}
{{2da column
|name= VFX
|type= int
|description= Visual Effect to apply when equipping item.
}}
{{2da column
|name= ScalingVector
|type= int
|description= Unknown at this time.
}}
{{2da column
|name= VFX
|type= int
|description= Visual Effect to apply when equipping item.
}}
{{2da column
|name= Comment
|type= comment
|description= A comment. Not compiled into the resulting .2da file.
}}
{{2da column
|name= BaseCost
|type= int
|description= Value added to item per point of power of this property.
}}
{{2da column
|name= IsNegative
|type= int
|description= If this property has a negative effect.
}}
{{2da column
|name= BaseDuration
|type= int
|description= Assumed to be duration of effect in seconds. Unconfirmed.
}}
{{2da column
|name= ProjectileCrust
|type= int
|description= Visual Effect to apply to projectiles fired from this item.
}}
{{2da column
|name= AbilityID
|type= int
|description= Ability to use for onhit (IPType = 2) effects.
}}
{{2da end}}

Scripting overview

2009-12-13T06:37:03Z

JJM152: I added a few tables on the operators that the scripting language supports (arithmetic, logical, comparison, etc).

Scripting is used whenever the designers need control over the game's behaviour. The syntax for DA scripts is very similar to the C programming language.

Detailed documentation for the scripting language can be found in the "dascript.chm" file, available in your "Dragon Age\packages\core" directory.

The main uses for it are to:

*Trigger plot events
*Script conversation
*Handle creature and party member [[AI]]
*Script abilities - skills, talents, and spells

DA also has a client-side scripting language whose primary responsibility is automated testing of the game. See [[client script]]s for more details.

AI Scripts are event based. Objects will have only one event-handling script assigned to them that will be run whenever they receive a game event. This script will receive the event type as a parameter and will need to determine the appropriate response for itself.

There are several file extensions associated with scripts:
* NSS - script source file
* NCS - compiled script
* NDB - debug information file (required for using the script debugger to trace through this file)

== Script editor ==

Scripts are created in the Designer Toolset using the Script Editor. Once created, scripts must be assigned to such things as Creatures before they can be used. Once assigned, both the referencing object and the script must be exported in order to be viewed in the game. Exporting happens automatically or can be done manually by the designer during testing.

The script editor supports the following features:

*Undo and redo
*Find and replace
*Bookmarking: View -> Other Windows -> Bookmarks
*Function, variable, constant, and template browser (visible on the right-hand side of the screen).
*Auto-complete when typing function and variable names
*Syntax highlighting
*Auto-indention
*Brace matching/highlighting
*Ability to test compile a script
*Jump to definition

To the right of the script editor is a sidebar with a browser that can display all currently-defined functions, variables, or constants, or a set of 'template' scripts that can serve as a starting point when writing a script from scratch. The browser also has a filter field where you can type in a partial string and have the list automatically exclude everything that doesn't include it in the name.

This is the constant browser:

[[Image:Scripting constant browser.png]]

Here it is with "team" typed into the filter field, displaying only constants with names that contain the substring "team" (not case sensitive):

[[Image:Scripting constant browser filtered.png]]

The templates that come with Dragon Age include frameworks for the most common event scripts found in the game. You can add your own templates quite easily, just create a text file with the template code in it and place it in the Dragon Age\Toolset\scripttemplates directory with the others.

[[Image:scripting template browser.png]]

Dragon Age's toolset supports Doxygen-style comments. If you double-click on a function name a help window will pop open to display its documentation. You can also jump to a function's definition (provided it isn't an engine-defined function in script.ldf) by right-clicking on it and selecting "go to definition".

[[Image:Scripting help window.png]]

== Writing scripts ==

For a script to compile, it needs a body:
<dascript>
void main()
{
}
</dascript>
The parameters on this can't be changed or the script won't compile.

Scripts associated with a dialog node take this alternate form:
<dascript>
int StartingConditional()
{
return 1;
}
</dascript>

=== Including files ===
Other script files can be included by using the #include directive.
<dascript>
#include "rules"

void main()
{
DoSomethingOrOther();
}
</dascript>
The included file is inserted into the main file before the script is compiled. Any number of files can be included.

No other C-style preprocessor commands are supported.

=== Operators ===

The scripting language supports the following operators:

====Arithmetic Operators====
{|style="width:100%;border:solid 1px black;"
! style="width:25%;background-color:#ffffcc;" | Operator Name
! style="width:75%;background-color:#ffffcc;" | Example
|-
| Prefix Increment
| <dascript>while ( ++a < 10) { }</dascript>
|-
| Postfix Increment
| <dascript> for (i = 0; i < 10; i++) { } </dascript>
|-
| Assignment by addition
| <dascript>a += b;</dascript>
|-
| Subtraction (difference)
| <dascript>x = a - b;</dascript>
|-
| Addition (sum)
| <dascript>x = a + b;</dascript>
|-
| Prefix decrement
| <dascript>while (--a > 10) { }</dascript>
|-
| Postfix decrement
| <dascript>while (a-- > 10) { }</dascript>
|-
| Assignment by subtraction
| <dascript>a -= b;</dascript>
|-
| Multiplication (product)
| <dascript>x = a * b;</dascript>
|-
| Division (quotient)
| <dascript>x = a / b;</dascript>
|-
| Modulo (remainder)
| <dascript>if (a % b == 1) { }</dascript>
|}

====Comparison Operators====
{|style="width:100%;border:solid 1px black;"
! style="width:25%;background-color:#ffffcc;" | Operator Name
! style="width:75%;background-color:#ffffcc;" | Example
|-
| Less than
| <dascript>if (a < b) { }</dascript>
|-
| Less than or equal to
| <dascript>if (a <= b) { }</dascript>
|-
| Greater than
| <dascript>if (a > b) { }</dascript>
|-
| Greater than or equal to
| <dascript>if (a >= b) { }</dascript>
|-
| Not Equal to
| <dascript>if (a != b) { }</dascript>
|-
| Equal to
| <dascript>if (a == b) { }</dascript>
|}

====Logical Operators====
{|style="width:100%;border:solid 1px black;"
! style="width:25%;background-color:#ffffcc;" | Operator Name
! style="width:75%;background-color:#ffffcc;" | Example
|-
| Logical negation (NOT)
| <dascript>if (!a) { }</dascript>
|-
| Logical AND
| <dascript>if (a && b) { }</dascript>
|-
| Logical OR
| <dascript>if (a || b) { }</dascript>
|}

====Other Operators====
{|style="width:100%;border:solid 1px black;"
! style="width:25%;background-color:#ffffcc;" | Operator Name
! style="width:75%;background-color:#ffffcc;" | Example
|-
| Basic assignment
| <dascript>a = b;</dascript>
|-
| Function call
| <dascript>a();</dascript>
|-
| Array subscript
| <dascript>array[0] = 1;</dascript>
|-
| Member (on structures)
| <dascript>structure.member = 0;</dascript>
|-
| Ternary conditional
| <dascript>return a 
|}
=== Types & Variable ===

The scripting language natively supports:
* [[float]] - floating-point numbers. <dascript>float fFloat = 0.1234f;</dascript>
* [[int]] - integer numbers. <dascript>int nInteger = 1234;</dascript>
* [[object]] -game object files. <dascript>object oObject = GetObjectByTag("monster_001");</dascript>
* [[resource]] - game resource files. <dascript>resource rGameIntroCutscene = R"game_intro_.cut";</dascript>
* [[string]] - text strings. <dascript>string sString = "Hello World!";</dascript>
* [[vector]] - positions or directions. <dascript>vector vVector = Vector(0.0, 1.1, 2.2);</dascript>

The server language has been expanded to support these engine defined structures:
* [[event]] - events are signals that are sent to scripts by other scripts or by the world engine.
* [[location]]
* [[command]] - a command for a creature or object to do something. Commands are constructed using functions that return them, and then are added to a target's command queue with the AddCommand function.
* [[effect]]
* [[itemproperty]]
* [[player]]

All of these types are always passed by value, which means a new copy is made whenever they are passed into a function or copied to another variable.

This means that most functions that are supposed to modify a structure in some way need to return the modified one:

<dascript>
void main()
{
effect e1 = Effect(100);
effect e2 = SetEffectType(e1, 101); // e1 != e2
}
</dascript>

==== Structures ====

Users can define their own structures using the [[struct]] keyword:

<dascript>
// user-defined type
struct quaternion
{
float w, x, y, z;
};

// constructor
struct quaternion Quaternion(float fW, float fX, float fY, float fZ)
{
struct quaternion q;

q.w = fW;
q.x = fX;
q.y = fY;
q.z = fZ;

return q;
}

void main()
{
struct quaternion q = Quaternion(0.0, 0.0, 0.0, 0.0);
}
</dascript>

==== Arrays ====
Variables can be declared as arrays for any type except user-defined structs. Designers can create their own arrays of any major data type (int, string, object). Many functions will also return arrays (for example, creatures in an area will be returned as an array, and the action queue will be returned as an array).

These are different from C-style arrays in that they can be resized like STL vectors, and their notation is slightly different.

Arrays also behave differently from other objects in the scripting language because they are passed by reference. If an array is passed into a function and modified:

<dascript>
void main()
{
int[] i; // new array of integers with a size of zero
i[0] = 5; // value of array position 0 is now 5
i[1] = -1; // value of array position 1 is now -1

int[] j = i; // i and j point to the same array
j[1] = 12; // value of array position 1 for both i and j is now 12!

SortArrayDescending(i); // i and j are both sorted now, this function has no return value
}
</dascript>

[[GetArraySize]] returns the size of an array.

==== Local Variables ====

In Neverwinter Nights, variables for various objects could be created and set with functions such as SetLocalInt(). Dragon Age does not have analogous functions. Instead, all of the variables that a given object is able to have values assigned to must be defined ahead of time in a 2DA. This more restrictive approach is intended to improve performance and reduce the opportunity for errors (for example, making a typo in the name of a variable and losing track of it as a result).

=== Functions ===

There are two ways to discover a function and what it does.

If you type in the name of a function that's been defined and then an opening bracket, a tooltip will pop up showing the function's parameter types and return type.

Alternately, if you have the help window open (View -> Other Windows -> Help Window), then whenever you select a function in the function browser a help page describing the function will be displayed.

=== Passing parameters to scripts ===

To pass parameters to scripts they must be called with the 'runscript' command. This can be useful for writing debug scripts or changing actions based on input. To accept parameters simply add this line to your script:

<dascript>
string sParams = GetLocalString(GetModule(),"RUNSCRIPT_VAR");
</dascript>

You can then type 'runscript scriptname parameter1 parameter2 ... paramaterN' to pass parameters.

Some examples:

<dascript>

// Debug script: heals the object with the given tag. If tag is invalid, nothing happens
void main()
{

string sTag = GetLocalString(GetModule(),"RUNSCRIPT_VAR");
object oCreature = GetObjectByTag(sTag);
effect eHeal = EffectHeal(25.0f)
//ApplyEffect...
}

</dascript>

<dascript>

// Debug script: applies the visual effect passed in as parameter to the player
void main()
{

string sEffect = GetLocalString(GetModule(),"RUNSCRIPT_VAR");
int nEffect = StringToInt(sEffect);
effect eVfx = EffectVisualEffect(nEffect);
//ApplyEffect...
}

</dascript>

=== Error messages and logging ===

See [[Script error]] for details of how to correct errors in scripts.

To enable script logging, edit or create <DragonAgeInstallDirectory>\bin_ship\[[ECLog.ini]] and set Script=1 in the [LogTypes] section.

== Timing ==

Commands, delayed events and object destruction all take place after the current script is finished running. Plot flags set in script are set in-line but the triggered plot script runs before the flag is actually set (this is clarified a bit in the plot script template).

Given that ExecuteScript is deprecated, HandleEvent should be used when you want the script to run in-line and DelayEvent should be used when you want to delay execution.

To delay execution when dealing with creatures, custom AI and (safe) command complete are nice tools. DelayEvent should be used whenever you know how long you want to wait before the event fires. (It can also be used in quite small time increments to give the illusion of smoothly sliding placeables with SetPosition or interpolate between two different atmosphere/lighting settings, but the overhead of this is noticeable if overused).

[[Category:Scripts]]