Dragon Age Toolset Wiki - User contributions [en]

Compatibility

2010-09-09T07:32:29Z

Nezroy: adding existing content PRCSCR section

DAO has an active modding community. Over time, players will accumulate many new campaigns and game mods. So, as a courtesy to players and other builders, it's helpful to try to make our mods mutually compatible.

From time to time, Bioware may well issue new releases, so it's good to reduce the risk of conflict in that respect, too.

Since we can't be sure that all authors will respect compatibility considerations, the emphasis here is on techniques that reduce the risk of conflict, regardless of what other people do (though not all are foolproof).

Obviously, there are some conflicts with no win-win (hurlocks can't be both green and purple at the same time), but that doesn't stop us trying to avoid unnecessary win-lose or corruption.

== Disable Add-Ins : Suggested Disclaimer ==

If the player disables all other add-ins on the in game DLC screen, no conflict should occur between them. Tedious, but effective.

This should rarely be necessary if the compatibility guidelines listed here are observed.

Exception : there is a [[Bug:_export_creates_unnecessary_core_override | toolset bug]] which produces content that persists in game, even when the add-in is disabled, unless the builder cleans it out before making the Builder-to-Player file. The same problem can occur if a builder has intentionally placed content in the packages\override folder (which should normally be avoided, as it is very rarely necessary).

Mod authors can work together to set player expectations in this respect. For example, the installation instructions might say

<dascript>Reasonable steps have been taken to make this mod compatible.
Obviously, the author has no control over the quality of other mods you may have installed.
So, to reduce the risk of conflict, you are are strongly advised to move all files out of your
packages\override folders, and consider disabling unnecessary community mods on your in-game
DLC screen, before playing.</dascript>

== Module Scope ==

Setting the Extended Module in Module properties to "Core Game Resources" means that the add-in will change every campaign in game. If that's not intended, select the campaign you're trying to extend e.g. Single Player for the official campaign, (None) for a new standalone campaign.

[[Compatibility#What_if_my_mod_extends_both_Single_Player_and_Awakening.3F | What if my mod extends both Single Player and Awakening?]]

== Resource Scope ==

The Owner Module resource property has a similar effect on individual design resources. It's easy to make a new core resource accidentally when copy-editing an official core resource, because the Owner Module defaults to core. This isn't obvious, but the resource will export to your module's core folder, where it will impact every campaign in game.

Normally, it's not a good idea to make new core resources.

Exception : items cannot be imported to a new campaign with the player character unless the template is included in both campaigns. One way of doing that is to make it a core resource - but that affects all campaigns, of course.

Placing resources in the packages folder should be avoided (unless you have a very good reason), because once a player has installed those resources, they persist, even when your add-in is disabled.

Unfortunately, the packages folder has to be used for resources that won't load from the addins folder, namely

* Tintmaps
* Resources which are required for the standalone Character Creator program

Art resources posted to local are always sent to the module's core folder.

== Resource Conflict ==

Resource names need to be unique within type. For example, genpt_party.plt and genpt_party.nss are different resources, becasue the type is different. However, if two modules both have resources called genpt_party.plt, only one will load in game, following the [[Source directory priorities]].

Within the toolset database, duplicate resource names are forbidden, but there's nothing to stop different builders making resources which accidentally conflict, so it's wise to choose a unique range of names. Each builder can register the prefix they require. See [[Naming_conventions#Resource_Naming_Convention | Resource Naming Convention]] and especially [[Prefixes in use]].

It is possible to override a core resource intentionally, by editing a copy, exporting it, and renaming it in the export folder to the same name as the original. However, almost invariably there is a cleaner way of doing this - for example, by changing the 2DA which identifies which resource to use.

== Existing Content Modification ==

When adding new content or content hooks to existing areas, do not modify the area directly and deploy the modified area as an override with your mod. This is incompatible with other mods trying to edit the same area since only one modified version of the area will "win", and changes made by other mods to that area will not be available. Instead, use the [[PRCSCR]] system to add new content to existing areas.

== 2DA Conflict ==

Conflict between 2DA mods can be reduced using the [[2DA#Extending_the_game_via_M2DAs | M2DA]] mechanism and [[2DA#Reserved_ID_Ranges_and_overriding_existing_rows | reserving ID ranges]].

2DA mods should normally be placed in the add-in's module folder. Exception : if they are meant to be universally applied to all campaigns, they should be in the addin/core/override folder. The packages override folder should normally be avoided (because that removes control from the player, by forcing the 2DA to load even if the player has disabled the add-in).

== String Conflict ==

When a new module is created, its properties include a [[String ID]] range which starts at a very large random number. This makes it very unlikely that text created by one add-in will override another.

See [[String ID]] main article for a discussion of how this impacts sharing between Builders.

== Event Handling Conflict ==

Bear in mind that an add-in which impacts all campaigns could have undesirable consequences if it changes scripts or event-handling, given that custom campaigns may well have made changes of their own. If in doubt, consider modding the Single Player campaign only.

See [[Event_override | event override]] for recommended methods of intercepting events.

Note that script resources are never overwritten in these methods. Conceptually, the event is intercepted by a custom script, then passed on (unless the event has been handled successfully and further processing would be harmful). In this way, mods try not to interfere unnecessarily with other scripts.

Given the variety of actions that can be taken in a script, and that fact that one mod can't know what other mods are trying to do, we can't guarantee that this approach will be entirely free of logical problems, but the Perfect is the enemy of the Good.

The simplest and safest method is to assign a custom event script to a resource. This is likely to be used by custom campaigns, and also by Single Player mods to specific resources, as it is the approach that Bioware devs have often recommended.

Mods which aim to impact all campaigns globally are better advised to use the second method, i.e. overriding [[Event_(dascript_type) | event]] handling using an Events M2DA. As illustrated in the example script, if possible the event should be passed on to the default handler of the event's target object (which might be a custom event script). In this way, a global mod can be compatible with custom campaigns and specific resource mods.

Unfortunately, if two mods simply try to override the same event with an M2DA, they will be incompatible.

The best solution to override, partially override, or just listen for events via M2DA at this point would be to use a system such as [http://social.bioware.com/project/1907/#details Event Manager], though to ensure compatibility all modules overriding or listening for events should also be using the same system.

In the case of modules trying to totally override an event, only one module that does so will ultimately "win" (no such modules can ever truly be compatible with one another short of merging their functionality into one unified module as possible), but utilizing a system such as Event Manager will allow modules to partially override an event (i.e. only handle the event in certain situations), and will allow any module to listen for an event (without handling it) before or after the event is handled.

== Plot Property ==

Scripts that impact all campaigns should respect the plot property on resources. For example, if a campaign author has flagged an NPC as plot, it might not be helpful to change the creature AI.

== Open Source ==

If mod authors choose to publish their source code, with no restrictions on re-deployment, other builders can work around any residual incompatibilities (either by understanding the conflict more clearly, or by integrating the mod into their own work).

This technical wiki is not the place to discuss any legal or ethical considerations.

== FAQ ==

=== What if my mod extends both Single Player and Awakening? ===

Just create two dazips for your module. Name one yourprefix_yourmodule_version and the other yourprefix_yourmodule_EP1_version.

Edit the Manifest.xml file inside yourprefix_yourmodule_EP_1_version.dazip.
Change the line

<AddInItem UID="yourprefix_yourmodule" Name="Your Module Name" ExtendedModuleUID="Single Player" Priority="100" Enabled="1" State="2" Format="1"> to

<AddInItem UID="yourprefix_yourmodule_EP_1" Name="Your Module Name" ExtendedModuleUID="DAO_PRC_EP_1" Priority="200" Enabled="1" State="2" Format="1">

See also [[Talk:Compatibility | Discussion]]

=== How can I import an item with my existing character to a new campaign? ===

The Awakening expansion allows an existing character to be imported from one campaign to another.

There are two methods of ensuring that an item in the player's inventory is imported successfully:

* Make the item a core resource
* Include the item template in separate add-ins to both campaigns (see Awakening example above)

=== How can I stop items being imported into my campaign? ===

Assuming your campaign allows existing characters to be imported during Character Generation, you might want to clear the player's inventory before adding your starting equipment. Imported equipment might upset the balance of your campaign.

If you decide to do this, it's a good idea to warn players, so that they understand what's happening.

PRCSCR

2010-09-09T07:23:46Z

Nezroy: /* Overview */

The PRCSCR system enables a modder to add content into existing campaign areas in a fully compatible manner.

== Overview ==

PRCSCR (Post Release Content Script) is a sytem that executes custom scripts on entry into a game area in a manner that is fully [[Compatibility|compatible]] with existing campaign resources and 3rd party mods. The custom script can add the necessary hooks for new content to the existing area; placing items on vendors/in containers, adding map waypoints, spawning NPCs, adding doors/transitions to new areas, etc. This system is used by Bioware's DLC to add new content hooks, and it is the preferred option for integrating new content because it does not modify or change any existing campaign resources (e.g. it is not necessary to modify and override existing areas, which is not compatible with other mods trying to affect the same area).

== PRCSCR M2DA ==

The system works by using an [[2DA#Extending_the_game_via_M2DAs|M2DA]] to specify a custom script to run when entering an [[area list]] (alternately, the script can be told to run on entering ANY area list). If multiple M2DAs specify a script to run for the same area list, ALL of these defined scripts will be run, preventing any compatibility issues and allowing for everyone's custom scripts to get a chance to run and do their thing.

The M2DA override for the PRCSCR system is [[PRCSCR.xls]].

== Scripts ==

The usefulness of PRCSCR is that it can run ANY custom script you want. Anything that you can add to the game via scripting can therefore be compatibly added to an existing area. There is a collection of [[PRCSCR Script Templates]] that provide PRCSCR scripts for several common tasks.

'''Note''': The script will be run every time the player enters the specified area list, so plot flags or similar methods are needed in the script to ensure that changes are only made once to the area.

'''Note''': A limitation on scripts is that you cannot add merchants or stages via scripting. To add a merchant to an area with PRCSCR, a workaround would be necessary (e.g. creating the merchant in a custom area attached to the same area list that is deployed with the mod, then moving the merchant with PRCSCR to the existing area).

== Usage Scenarios ==

'''Where it applies:'''

*You have made a new [[area]] and need to add a door to an existing location that transitions to your new area. With PRCSCR you can spawn an entrance door in an existing area without having to modify the area resources directly.

*You have made a new item. With PRCSCR you can add the new item to an existing vendor or an existing container without having to edit the vendor/container resource or the area that contains that resource.

*You have made a new [[Map_tutorial#Activating_and_deactivating_map_pins|map pin]] on the world map for a new area. With PRCSCR, you can "spawn" the map pin when the player next enters the game, or in response to certain plot or area conditions, including conditions based on main campaign plot flags (e.g. only after Lothering has been destroyed).

'''Where it doesn't apply:'''

*You have made a new interior area and are placing items or NPCs in this area. Because the new area is unique content for your mod, you do not need to use PRCSCR to modify it. However, you would still probably use PRCSCR to provide a link to your new area from an existing area/world map.

PRCSCR

2010-09-09T07:23:10Z

Nezroy: rewriting and cleaning up

The PRCSCR system enables a modder to add content into existing campaign areas in a fully compatible manner.

== Overview ==

PRCSCR (Post Release Content Script) is a sytem that executes custom scripts on entry into a game area in a manner that is fully [[Compatibility|compatible]] with existing campaign resources and 3rd party mods. The custom script can then add the necessary hooks for new content to the existing area; placing items on vendors/in containers, adding map waypoints, spawning NPCs, adding doors/transitions to new areas, etc. This system is used by Bioware's DLC to add new content hooks, and it is the preferred option for integrating new content because it does not modify or change any existing campaign resources (e.g. it is not necessary to modify and override existing areas, which is not compatible with other mods trying to affect the same area).

== PRCSCR M2DA ==

The system works by using an [[2DA#Extending_the_game_via_M2DAs|M2DA]] to specify a custom script to run when entering an [[area list]] (alternately, the script can be told to run on entering ANY area list). If multiple M2DAs specify a script to run for the same area list, ALL of these defined scripts will be run, preventing any compatibility issues and allowing for everyone's custom scripts to get a chance to run and do their thing.

The M2DA override for the PRCSCR system is [[PRCSCR.xls]].

== Scripts ==

The usefulness of PRCSCR is that it can run ANY custom script you want. Anything that you can add to the game via scripting can therefore be compatibly added to an existing area. There is a collection of [[PRCSCR Script Templates]] that provide PRCSCR scripts for several common tasks.

'''Note''': The script will be run every time the player enters the specified area list, so plot flags or similar methods are needed in the script to ensure that changes are only made once to the area.

'''Note''': A limitation on scripts is that you cannot add merchants or stages via scripting. To add a merchant to an area with PRCSCR, a workaround would be necessary (e.g. creating the merchant in a custom area attached to the same area list that is deployed with the mod, then moving the merchant with PRCSCR to the existing area).

== Usage Scenarios ==

'''Where it applies:'''

*You have made a new [[area]] and need to add a door to an existing location that transitions to your new area. With PRCSCR you can spawn an entrance door in an existing area without having to modify the area resources directly.

*You have made a new item. With PRCSCR you can add the new item to an existing vendor or an existing container without having to edit the vendor/container resource or the area that contains that resource.

*You have made a new [[Map_tutorial#Activating_and_deactivating_map_pins|map pin]] on the world map for a new area. With PRCSCR, you can "spawn" the map pin when the player next enters the game, or in response to certain plot or area conditions, including conditions based on main campaign plot flags (e.g. only after Lothering has been destroyed).

'''Where it doesn't apply:'''

*You have made a new interior area and are placing items or NPCs in this area. Because the new area is unique content for your mod, you do not need to use PRCSCR to modify it. However, you would still probably use PRCSCR to provide a link to your new area from an existing area/world map.

PRCSCR Script Templates

2010-09-09T06:52:04Z

Nezroy: /* Adding an Item to an existing Vendor or Container */

This page serves as a repository for ready to use M2DA's and Scripts to use in conjunction with [[PRCSCR]] M2DA's when adding custom content to the game.

References:
*See Main Article: ''[[PRCSCR]]''
*See ''[[PRCSCR.xls]]'' for details about that M2DA, or ''[[2DA]]'' for an explanation of 2DA's as a whole
*To create a Script, right click in the Resourcepalette and select "New/Script" , or see ''[[Designer Resources]]'' for such Resources as a whole.


__NOTOC__
'''Contents:'''
{| style="background-color:#eeeeee; border:2px #999999 solid; padding:4px; margin:4px" border="3"
| width=300 |[[PRCSCR Script Templates#Adding a placeable into an existing Area|1. Adding a placeable into an existing Area]]
| width=800 |This Script serves to add a placeable of your choice into an Area of choice. ''(non removable)''
|-
| [[PRCSCR Script Templates#Adding a NPC into an existing Area|2. Adding a NPC into an existing Area]]
| This Script serves to any custom NPC or Creature to a Area of choice. ''(removable)''
|-
| [[PRCSCR Script Templates#Activating a Waypoint on the Worldmap|3. Activating a Waypoint on the Worldmap]]
| This Script serves to activate a custom Waypoint (Map Pin) of choice ,when leaving Lothering or at any other time into the Game.
|-
| [[PRCSCR Script Templates#Adding an Item into the Players Inventory|4. Adding an Item into the Players Inventory]]
| This Script serves to instantly add an Item into the Players Inventory.
|-
| [[PRCSCR Script Templates#Adding an Item to an existing Vendor or Container|5. Adding an Item to an existing Vendor or Container]]
| This Script serves to add any Item into a existing Vendors Inventory, as long the Vendor exists.
|-
| 6. Adding a Working Door into an existing Area
| This Script serves to add a custom Door into a existing Area, that the Player can enter into a custom Area.
|-
| 7. Adding a Quest to an existing Chanters Board
| This Script serves to add a new Quest to a existing Chanters Board, at any chosen time into the Game.
|-
| 8. ...
| ...
|}

== Adding a placeable into an existing Area ==

'''M2DA Setup:'''

#AreaListName must not be "any". Chose a specific one.
#Copy the GDA into your modules override folder.

'''Script:''' (As taken from the Storage Chest mod a kind Bioware employee made :o)

<dascript>
//const string TAL_STORAGE_CHEST_SPAWNED = "TAL_STORAGE_CHEST_SPAWNED";
const string TAL_IP_STORAGE_CHEST = "tal_ip_storage_chest";
const resource TAL_RESOURCE_IP_STORAGE_CHEST = R"tal_ip_storage_chest.utp";

void main()
{
object oMainControlled = GetMainControlled();
object oChest = UT_GetNearestObjectByTag(oMainControlled, TAL_IP_STORAGE_CHEST);

//DisplayFloatyMessage(oMainControlled, "storage script working", FLOATY_MESSAGE, 16777215, 30.0);

if (!IsObjectValid(oChest))
{
location lSpawn = Location(GetArea(oMainControlled), Vector(148.77, 117.68, -0.94), 0.0);
CreateObject(OBJECT_TYPE_PLACEABLE, TAL_RESOURCE_IP_STORAGE_CHEST, lSpawn);

//DisplayFloatyMessage(oMainControlled, "storage chest created", FLOATY_MESSAGE, 16777215, 30.0);
}
}
</dascript>

#Replace "tal_ip_storage_chest" in the 2nd line with the "Tag" of your own placeable. (only small letters allowed)
#Replace "tal_ip_storage_chest.utp" in 3rd line with the Resources Filename of your placable.
#Exchange the (4) numbers after it sais "Vector" ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the placeable until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the placeable ,and start the game. When you arrive at the specific Area in game, the Placeable will be there.

'''Note:''' This method prevents removal of the placable. Check out a Plot driven method.

== Adding a NPC into an existing Area ==

'''M2DA Setup:'''

#AreaListName must be "any". This Script is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
// this is the name of a precreated plot file "joblos_quest" prefixed with the special "plt_"
// "plt_" + quest name allows you to reference the flag names as constants.
#include "plt_joblos_quest"
#include "wrappers_h"

void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag(PLT_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
); //this semicolom was missing and caused errors

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

#Replace "joblos_quest" (3x) with the name of your Plot.
#Replace "JOBLO_ADDED_TO_TOWN" (2x) with a custom Flag you create in your Plot.
#Replace "lot100ar_lothering" with the Tag of an Area ,the NPC should spawn in.
#Replace "joblo.utc" with the filename of your [[Creature]].
#Exchange the (4) numbers ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the NPC until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the creature ,and start the game. When you arrive at the specific Area in game, the [[Creature]] (Monsters or NPCs alike) will be there.

== Activating a Waypoint on the Worldmap ==

'''Requirements:''' Your module must extend Single Player.

'''M2DA Setup:'''

#AreaListName must be "any". Because Waypoint activation should be universal and it is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
const string WML_WOW_Custom = "eshmeswp";
#include "plt_mnp000pt_main_events"
#include "wrappers_h"
void main()
{
if(WR_GetPlotFlag( PLT_MNP000PT_MAIN_EVENTS, ARCHDEMON_EVENT_ONE) == TRUE )
{
WR_SetWorldMapLocationStatus(GetObjectByTag(WML_WOW_Custom), WM_LOCATION_ACTIVE);
}
}
</dascript>

#Replace "eshmeswp" in the 1st line with the "Tag" of your Waypoint (Map Pin) which u created. That Map Pin can be greyed out or inactive or so. Map Pin information can be found at: [[Map]].

Export the script, the Map ,and start the game. The Waypoint will now be activated once you leave Lothering, just like the other main Waypoints. This is to get in line with the Story. However to change the time of it happening..

#Choose which [[Plot]] should activate the Waypoint. The above example uses the Archdemon quest, when your nightmare triggers for example.
#Exchange "mnp000pt_main_events" in the 2nd and 6th line with the name of that other [[Plot]]. Leaving the "plt_" there.
#Exchange "ARCHDEMON_EVENT_ONE" with a "Flag" of your choice from that Plot.

This "should" work for any plot. Actually, waypoints dont need all this PRCSCR stuff and can be set "Active" in the first place. But the above example is to get in line with the Main Campaign, and potential gamebreaking Plot conflicts if able to leave Lothering too early.

== Adding an Item into the Players Inventory ==

'''Requirements:'''

'''M2DA Setup:'''
#AreaListName is "any".
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
//include utility_h for the UT_AddItemToInventory() function.
#include "utility_h"
//include the custom made plot file
#include "plt_$plot_file_name$"

void main()
{
// If plot flag is TRUE then item already given.
// Otherwise add item to inventory.
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == FALSE )
{
UT_AddItemToInventory(R"$item_file_name$.uti");
//Set the plot flag to TRUE to indicate that the item was given.
WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>
# Replace everything between and including the $ signs with appropriate names (without the file extensions).

== Adding an Item to an existing Vendor or Container ==

'''Requirements:'''

'''M2DA Setup:'''

{| border="1"
! Campaign !! Container !! ContainerTag !! AreaListName
|-
|Origins || Bodahn || store_camp_bodahn || cam100ar_camp_plains
|-
|Origins || daytime King's Camp quartermaster || pre100sr_quartermaster || pre01al_kings_camp
|-
|Awakening || Yuriah || store_vgk100cr_merchant || vgk210ar_throne_room
|-
|Awakening || Party Chest in Vigil's Keep || vgk210ip_party_chest || vgk210ar_throne_room
|-
|Leliana's Song || first Lem encounter || store_lel00cr_lem || lel100ar_market
|}

#Create a [[PRCSCR.xls|PRCSCR M2DA override]] using the desired AreaListName from the above table
#Copy this new PRCSCR M2DA into your module's override folder (AddIns\{YourMod}\core\override)

'''Script:'''

<dascript>
#include "wrappers_h"
#include "plt_$plot_file_name$" // include your custom plot

void main()
{
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == TRUE ) return;

object oContainer = GetObjectByTag($ContainerTag$);

if (IsObjectValid(oContainer))
{
CreateItemOnObject(R"$resource_name$.uti", oContainer, 1, "", TRUE); // repeat this for each item

WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>

#Replace "$plot_file_name$" and "$check_flag_name$" with the custom [[Plot#Scripting|plot and plot flags]] you create for your module.
#Replace "$resource_name$" with the resource name of your custom item.
#Replace "$ContainerTag$" with the desired container tag from the table in the M2DA setup section.
#The very first time you go to the party camp in Origins (after leaving Lothering) and view the Archdemon cutscene, this script will NOT run when using "cam100ar_camp_plains" as the AreaListName. This is because the cutscene version of the camp is actually a different area. In this case you must exit and return to the "normal" (non-cutscene) party camp for the script to run for the first time.

== Adding a Working Door into an existing Area ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

== Adding a Quest to an existing Chanters Board ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

[[category:tutorials]]
[[Category:Scripts]]
[[Category:Pages with example scripts]]

PRCSCR Script Templates

2010-09-09T06:42:27Z

Nezroy: /* Adding an Item to an existing Vendor or Container */ table formatting for different containers

This page serves as a repository for ready to use M2DA's and Scripts to use in conjunction with [[PRCSCR]] M2DA's when adding custom content to the game.

References:
*See Main Article: ''[[PRCSCR]]''
*See ''[[PRCSCR.xls]]'' for details about that M2DA, or ''[[2DA]]'' for an explanation of 2DA's as a whole
*To create a Script, right click in the Resourcepalette and select "New/Script" , or see ''[[Designer Resources]]'' for such Resources as a whole.


__NOTOC__
'''Contents:'''
{| style="background-color:#eeeeee; border:2px #999999 solid; padding:4px; margin:4px" border="3"
| width=300 |[[PRCSCR Script Templates#Adding a placeable into an existing Area|1. Adding a placeable into an existing Area]]
| width=800 |This Script serves to add a placeable of your choice into an Area of choice. ''(non removable)''
|-
| [[PRCSCR Script Templates#Adding a NPC into an existing Area|2. Adding a NPC into an existing Area]]
| This Script serves to any custom NPC or Creature to a Area of choice. ''(removable)''
|-
| [[PRCSCR Script Templates#Activating a Waypoint on the Worldmap|3. Activating a Waypoint on the Worldmap]]
| This Script serves to activate a custom Waypoint (Map Pin) of choice ,when leaving Lothering or at any other time into the Game.
|-
| [[PRCSCR Script Templates#Adding an Item into the Players Inventory|4. Adding an Item into the Players Inventory]]
| This Script serves to instantly add an Item into the Players Inventory.
|-
| [[PRCSCR Script Templates#Adding an Item to an existing Vendor or Container|5. Adding an Item to an existing Vendor or Container]]
| This Script serves to add any Item into a existing Vendors Inventory, as long the Vendor exists.
|-
| 6. Adding a Working Door into an existing Area
| This Script serves to add a custom Door into a existing Area, that the Player can enter into a custom Area.
|-
| 7. Adding a Quest to an existing Chanters Board
| This Script serves to add a new Quest to a existing Chanters Board, at any chosen time into the Game.
|-
| 8. ...
| ...
|}

== Adding a placeable into an existing Area ==

'''M2DA Setup:'''

#AreaListName must not be "any". Chose a specific one.
#Copy the GDA into your modules override folder.

'''Script:''' (As taken from the Storage Chest mod a kind Bioware employee made :o)

<dascript>
//const string TAL_STORAGE_CHEST_SPAWNED = "TAL_STORAGE_CHEST_SPAWNED";
const string TAL_IP_STORAGE_CHEST = "tal_ip_storage_chest";
const resource TAL_RESOURCE_IP_STORAGE_CHEST = R"tal_ip_storage_chest.utp";

void main()
{
object oMainControlled = GetMainControlled();
object oChest = UT_GetNearestObjectByTag(oMainControlled, TAL_IP_STORAGE_CHEST);

//DisplayFloatyMessage(oMainControlled, "storage script working", FLOATY_MESSAGE, 16777215, 30.0);

if (!IsObjectValid(oChest))
{
location lSpawn = Location(GetArea(oMainControlled), Vector(148.77, 117.68, -0.94), 0.0);
CreateObject(OBJECT_TYPE_PLACEABLE, TAL_RESOURCE_IP_STORAGE_CHEST, lSpawn);

//DisplayFloatyMessage(oMainControlled, "storage chest created", FLOATY_MESSAGE, 16777215, 30.0);
}
}
</dascript>

#Replace "tal_ip_storage_chest" in the 2nd line with the "Tag" of your own placeable. (only small letters allowed)
#Replace "tal_ip_storage_chest.utp" in 3rd line with the Resources Filename of your placable.
#Exchange the (4) numbers after it sais "Vector" ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the placeable until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the placeable ,and start the game. When you arrive at the specific Area in game, the Placeable will be there.

'''Note:''' This method prevents removal of the placable. Check out a Plot driven method.

== Adding a NPC into an existing Area ==

'''M2DA Setup:'''

#AreaListName must be "any". This Script is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
// this is the name of a precreated plot file "joblos_quest" prefixed with the special "plt_"
// "plt_" + quest name allows you to reference the flag names as constants.
#include "plt_joblos_quest"
#include "wrappers_h"

void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag(PLT_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
); //this semicolom was missing and caused errors

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

#Replace "joblos_quest" (3x) with the name of your Plot.
#Replace "JOBLO_ADDED_TO_TOWN" (2x) with a custom Flag you create in your Plot.
#Replace "lot100ar_lothering" with the Tag of an Area ,the NPC should spawn in.
#Replace "joblo.utc" with the filename of your [[Creature]].
#Exchange the (4) numbers ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the NPC until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the creature ,and start the game. When you arrive at the specific Area in game, the [[Creature]] (Monsters or NPCs alike) will be there.

== Activating a Waypoint on the Worldmap ==

'''Requirements:''' Your module must extend Single Player.

'''M2DA Setup:'''

#AreaListName must be "any". Because Waypoint activation should be universal and it is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
const string WML_WOW_Custom = "eshmeswp";
#include "plt_mnp000pt_main_events"
#include "wrappers_h"
void main()
{
if(WR_GetPlotFlag( PLT_MNP000PT_MAIN_EVENTS, ARCHDEMON_EVENT_ONE) == TRUE )
{
WR_SetWorldMapLocationStatus(GetObjectByTag(WML_WOW_Custom), WM_LOCATION_ACTIVE);
}
}
</dascript>

#Replace "eshmeswp" in the 1st line with the "Tag" of your Waypoint (Map Pin) which u created. That Map Pin can be greyed out or inactive or so. Map Pin information can be found at: [[Map]].

Export the script, the Map ,and start the game. The Waypoint will now be activated once you leave Lothering, just like the other main Waypoints. This is to get in line with the Story. However to change the time of it happening..

#Choose which [[Plot]] should activate the Waypoint. The above example uses the Archdemon quest, when your nightmare triggers for example.
#Exchange "mnp000pt_main_events" in the 2nd and 6th line with the name of that other [[Plot]]. Leaving the "plt_" there.
#Exchange "ARCHDEMON_EVENT_ONE" with a "Flag" of your choice from that Plot.

This "should" work for any plot. Actually, waypoints dont need all this PRCSCR stuff and can be set "Active" in the first place. But the above example is to get in line with the Main Campaign, and potential gamebreaking Plot conflicts if able to leave Lothering too early.

== Adding an Item into the Players Inventory ==

'''Requirements:'''

'''M2DA Setup:'''
#AreaListName is "any".
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
//include utility_h for the UT_AddItemToInventory() function.
#include "utility_h"
//include the custom made plot file
#include "plt_$plot_file_name$"

void main()
{
// If plot flag is TRUE then item already given.
// Otherwise add item to inventory.
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == FALSE )
{
UT_AddItemToInventory(R"$item_file_name$.uti");
//Set the plot flag to TRUE to indicate that the item was given.
WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>
# Replace everything between and including the $ signs with appropriate names (without the file extensions).

== Adding an Item to an existing Vendor or Container ==

'''Requirements:'''

'''M2DA Setup:'''

{| border="1"
! Campaign !! Container !! ContainerTag !! AreaListName
|-
|Origins || Bodahn || store_camp_bodahn || cam100ar_camp_plains
|-
|Origins || daytime King's Camp quartermaster || pre100sr_quartermaster || pre01al_kings_camp
|-
|Awakening || Yuriah || store_vgk100cr_merchant || vgk210ar_throne_room
|-
|Awakening || Party Chest in Vigil's Keep || vgk210ip_party_chest || vgk210ar_throne_room
|-
|Leliana's Song || first Lem encounter || store_lel00cr_lem || lel100ar_market
|}

#Create a GDA PRCSCR override using the desired AreaListName from the above table
#Copy the GDA PRCSCR into your module's override folder (AddIns\{YourMod}\core\override)

'''Script:'''

<dascript>
#include "wrappers_h"
#include "plt_$plot_file_name$" // include your custom plot

void main()
{
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == TRUE ) return;

object oContainer = GetObjectByTag($ContainerTag$);

if (IsObjectValid(oContainer))
{
CreateItemOnObject(R"$resource_name$.uti", oContainer, 1, "", TRUE); // repeat this for each item

WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>

#Replace "$plot_file_name$" and "$check_flag_name$" with the custom [[Plot#Scripting|plot and plot flags]] you create for your module.
#Replace "$resource_name$" with the resource name of your custom item.
#Replace "$ContainerTag$" with the desired container tag from the table in the M2DA setup section.
#The very first time you go to the party camp in Origins (after leaving Lothering) and view the Archdemon cutscene, this script will NOT run when using "cam100ar_camp_plains" as the AreaListName. This is because the cutscene version of the camp is actually a different area. In this case you must exit and return to the "normal" (non-cutscene) party camp for the script to run for the first time.

== Adding a Working Door into an existing Area ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

== Adding a Quest to an existing Chanters Board ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

[[category:tutorials]]
[[Category:Scripts]]
[[Category:Pages with example scripts]]

PRCSCR Script Templates

2010-09-09T06:30:29Z

Nezroy: minor section title change

This page serves as a repository for ready to use M2DA's and Scripts to use in conjunction with [[PRCSCR]] M2DA's when adding custom content to the game.

References:
*See Main Article: ''[[PRCSCR]]''
*See ''[[PRCSCR.xls]]'' for details about that M2DA, or ''[[2DA]]'' for an explanation of 2DA's as a whole
*To create a Script, right click in the Resourcepalette and select "New/Script" , or see ''[[Designer Resources]]'' for such Resources as a whole.


__NOTOC__
'''Contents:'''
{| style="background-color:#eeeeee; border:2px #999999 solid; padding:4px; margin:4px" border="3"
| width=300 |[[PRCSCR Script Templates#Adding a placeable into an existing Area|1. Adding a placeable into an existing Area]]
| width=800 |This Script serves to add a placeable of your choice into an Area of choice. ''(non removable)''
|-
| [[PRCSCR Script Templates#Adding a NPC into an existing Area|2. Adding a NPC into an existing Area]]
| This Script serves to any custom NPC or Creature to a Area of choice. ''(removable)''
|-
| [[PRCSCR Script Templates#Activating a Waypoint on the Worldmap|3. Activating a Waypoint on the Worldmap]]
| This Script serves to activate a custom Waypoint (Map Pin) of choice ,when leaving Lothering or at any other time into the Game.
|-
| [[PRCSCR Script Templates#Adding an Item into the Players Inventory|4. Adding an Item into the Players Inventory]]
| This Script serves to instantly add an Item into the Players Inventory.
|-
| [[PRCSCR Script Templates#Adding an Item to an existing Vendor or Container|5. Adding an Item to an existing Vendor or Container]]
| This Script serves to add any Item into a existing Vendors Inventory, as long the Vendor exists.
|-
| 6. Adding a Working Door into an existing Area
| This Script serves to add a custom Door into a existing Area, that the Player can enter into a custom Area.
|-
| 7. Adding a Quest to an existing Chanters Board
| This Script serves to add a new Quest to a existing Chanters Board, at any chosen time into the Game.
|-
| 8. ...
| ...
|}

== Adding a placeable into an existing Area ==

'''M2DA Setup:'''

#AreaListName must not be "any". Chose a specific one.
#Copy the GDA into your modules override folder.

'''Script:''' (As taken from the Storage Chest mod a kind Bioware employee made :o)

<dascript>
//const string TAL_STORAGE_CHEST_SPAWNED = "TAL_STORAGE_CHEST_SPAWNED";
const string TAL_IP_STORAGE_CHEST = "tal_ip_storage_chest";
const resource TAL_RESOURCE_IP_STORAGE_CHEST = R"tal_ip_storage_chest.utp";

void main()
{
object oMainControlled = GetMainControlled();
object oChest = UT_GetNearestObjectByTag(oMainControlled, TAL_IP_STORAGE_CHEST);

//DisplayFloatyMessage(oMainControlled, "storage script working", FLOATY_MESSAGE, 16777215, 30.0);

if (!IsObjectValid(oChest))
{
location lSpawn = Location(GetArea(oMainControlled), Vector(148.77, 117.68, -0.94), 0.0);
CreateObject(OBJECT_TYPE_PLACEABLE, TAL_RESOURCE_IP_STORAGE_CHEST, lSpawn);

//DisplayFloatyMessage(oMainControlled, "storage chest created", FLOATY_MESSAGE, 16777215, 30.0);
}
}
</dascript>

#Replace "tal_ip_storage_chest" in the 2nd line with the "Tag" of your own placeable. (only small letters allowed)
#Replace "tal_ip_storage_chest.utp" in 3rd line with the Resources Filename of your placable.
#Exchange the (4) numbers after it sais "Vector" ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the placeable until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the placeable ,and start the game. When you arrive at the specific Area in game, the Placeable will be there.

'''Note:''' This method prevents removal of the placable. Check out a Plot driven method.

== Adding a NPC into an existing Area ==

'''M2DA Setup:'''

#AreaListName must be "any". This Script is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
// this is the name of a precreated plot file "joblos_quest" prefixed with the special "plt_"
// "plt_" + quest name allows you to reference the flag names as constants.
#include "plt_joblos_quest"
#include "wrappers_h"

void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag(PLT_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
); //this semicolom was missing and caused errors

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

#Replace "joblos_quest" (3x) with the name of your Plot.
#Replace "JOBLO_ADDED_TO_TOWN" (2x) with a custom Flag you create in your Plot.
#Replace "lot100ar_lothering" with the Tag of an Area ,the NPC should spawn in.
#Replace "joblo.utc" with the filename of your [[Creature]].
#Exchange the (4) numbers ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the NPC until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the creature ,and start the game. When you arrive at the specific Area in game, the [[Creature]] (Monsters or NPCs alike) will be there.

== Activating a Waypoint on the Worldmap ==

'''Requirements:''' Your module must extend Single Player.

'''M2DA Setup:'''

#AreaListName must be "any". Because Waypoint activation should be universal and it is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
const string WML_WOW_Custom = "eshmeswp";
#include "plt_mnp000pt_main_events"
#include "wrappers_h"
void main()
{
if(WR_GetPlotFlag( PLT_MNP000PT_MAIN_EVENTS, ARCHDEMON_EVENT_ONE) == TRUE )
{
WR_SetWorldMapLocationStatus(GetObjectByTag(WML_WOW_Custom), WM_LOCATION_ACTIVE);
}
}
</dascript>

#Replace "eshmeswp" in the 1st line with the "Tag" of your Waypoint (Map Pin) which u created. That Map Pin can be greyed out or inactive or so. Map Pin information can be found at: [[Map]].

Export the script, the Map ,and start the game. The Waypoint will now be activated once you leave Lothering, just like the other main Waypoints. This is to get in line with the Story. However to change the time of it happening..

#Choose which [[Plot]] should activate the Waypoint. The above example uses the Archdemon quest, when your nightmare triggers for example.
#Exchange "mnp000pt_main_events" in the 2nd and 6th line with the name of that other [[Plot]]. Leaving the "plt_" there.
#Exchange "ARCHDEMON_EVENT_ONE" with a "Flag" of your choice from that Plot.

This "should" work for any plot. Actually, waypoints dont need all this PRCSCR stuff and can be set "Active" in the first place. But the above example is to get in line with the Main Campaign, and potential gamebreaking Plot conflicts if able to leave Lothering too early.

== Adding an Item into the Players Inventory ==

'''Requirements:'''

'''M2DA Setup:'''
#AreaListName is "any".
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
//include utility_h for the UT_AddItemToInventory() function.
#include "utility_h"
//include the custom made plot file
#include "plt_$plot_file_name$"

void main()
{
// If plot flag is TRUE then item already given.
// Otherwise add item to inventory.
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == FALSE )
{
UT_AddItemToInventory(R"$item_file_name$.uti");
//Set the plot flag to TRUE to indicate that the item was given.
WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>
# Replace everything between and including the $ signs with appropriate names (without the file extensions).

== Adding an Item to an existing Vendor or Container ==

'''Requirements:'''

'''M2DA Setup:'''

#Origins (Bodahn) - AreaListName should be "cam100ar_camp_plains".
#Origins (daytime King's Camp vendor) - AreaListName should be "pre01al_kings_camp".
#Awakening (Yuriah or Personal Chest) - AreaListName should be "vgk210ar_throne_room".
#Leliana's Song (first Lem encounter) - AreaListName should be "lel100ar_market".
#Copy the GDA into your module's override folder (AddIns\{YourMod}\core\override)

'''Script:'''

<dascript>
#include "wrappers_h"
#include "plt_$plot_file_name$" // include your custom plot

void main()
{
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == TRUE ) return;

object oStore = GetObjectByTag("store_camp_bodahn"); // use this one for Origins/Bodahn
object oStore = GetObjectByTag("pre100sr_quartermaster"); // use this one for Origins/daytime King's Camp vendor
object oStore = GetObjectByTag("store_vgk100cr_merchant"); // use this one for Awakening/Yuriah
object oStore = GetObjectByTag("vgk210ip_party_chest"); // use this one for Awakening/Peronsal Chest
object oStore = GetObjectByTag("store_lel00cr_lem"); // use this one for Leliana's Song/first Lem encounter

if (IsObjectValid(oStore))
{
CreateItemOnObject(R"$resource_name$.uti", oStore, 1, "", TRUE); // repeat this for each item

WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>

#Replace "$plot_file_name$" and "$check_flag_name$" with the custom [[Plot#Scripting|plot and plot flags]] you create for your module.
#Replace "$resource_name$" with the resource name of your custom item.
#The very first time you go to the party camp in Origins (after leaving Lothering) and view the Archdemon cutscene, this script will NOT run. This is because the cutscene version of the camp is actually a different area. In this case you must exit and return to the "normal" (non-cutscene) party camp for the script to run for the first time.

== Adding a Working Door into an existing Area ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

== Adding a Quest to an existing Chanters Board ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

[[category:tutorials]]
[[Category:Scripts]]
[[Category:Pages with example scripts]]

PRCSCR Script Templates

2010-09-09T06:26:55Z

Nezroy: /* Adding an Item to an existing Vendor */ added more areas and vendors

This page serves as a repository for ready to use M2DA's and Scripts to use in conjunction with [[PRCSCR]] M2DA's when adding custom content to the game.

References:
*See Main Article: ''[[PRCSCR]]''
*See ''[[PRCSCR.xls]]'' for details about that M2DA, or ''[[2DA]]'' for an explanation of 2DA's as a whole
*To create a Script, right click in the Resourcepalette and select "New/Script" , or see ''[[Designer Resources]]'' for such Resources as a whole.


__NOTOC__
'''Contents:'''
{| style="background-color:#eeeeee; border:2px #999999 solid; padding:4px; margin:4px" border="3"
| width=300 |[[PRCSCR Script Templates#Adding a placeable into an existing Area|1. Adding a placeable into an existing Area]]
| width=800 |This Script serves to add a placeable of your choice into an Area of choice. ''(non removable)''
|-
| [[PRCSCR Script Templates#Adding a NPC into an existing Area|2. Adding a NPC into an existing Area]]
| This Script serves to any custom NPC or Creature to a Area of choice. ''(removable)''
|-
| [[PRCSCR Script Templates#Activating a Waypoint on the Worldmap|3. Activating a Waypoint on the Worldmap]]
| This Script serves to activate a custom Waypoint (Map Pin) of choice ,when leaving Lothering or at any other time into the Game.
|-
| [[PRCSCR Script Templates#Adding an Item into the Players Inventory|4. Adding an Item into the Players Inventory]]
| This Script serves to instantly add an Item into the Players Inventory.
|-
| [[PRCSCR Script Templates#Adding an Item to an existing Vendor|5. Adding an Item to an existing Vendor]]
| This Script serves to add any Item into a existing Vendors Inventory, as long the Vendor exists.
|-
| 6. Adding a Working Door into an existing Area
| This Script serves to add a custom Door into a existing Area, that the Player can enter into a custom Area.
|-
| 7. Adding a Quest to an existing Chanters Board
| This Script serves to add a new Quest to a existing Chanters Board, at any chosen time into the Game.
|-
| 8. ...
| ...
|}

== Adding a placeable into an existing Area ==

'''M2DA Setup:'''

#AreaListName must not be "any". Chose a specific one.
#Copy the GDA into your modules override folder.

'''Script:''' (As taken from the Storage Chest mod a kind Bioware employee made :o)

<dascript>
//const string TAL_STORAGE_CHEST_SPAWNED = "TAL_STORAGE_CHEST_SPAWNED";
const string TAL_IP_STORAGE_CHEST = "tal_ip_storage_chest";
const resource TAL_RESOURCE_IP_STORAGE_CHEST = R"tal_ip_storage_chest.utp";

void main()
{
object oMainControlled = GetMainControlled();
object oChest = UT_GetNearestObjectByTag(oMainControlled, TAL_IP_STORAGE_CHEST);

//DisplayFloatyMessage(oMainControlled, "storage script working", FLOATY_MESSAGE, 16777215, 30.0);

if (!IsObjectValid(oChest))
{
location lSpawn = Location(GetArea(oMainControlled), Vector(148.77, 117.68, -0.94), 0.0);
CreateObject(OBJECT_TYPE_PLACEABLE, TAL_RESOURCE_IP_STORAGE_CHEST, lSpawn);

//DisplayFloatyMessage(oMainControlled, "storage chest created", FLOATY_MESSAGE, 16777215, 30.0);
}
}
</dascript>

#Replace "tal_ip_storage_chest" in the 2nd line with the "Tag" of your own placeable. (only small letters allowed)
#Replace "tal_ip_storage_chest.utp" in 3rd line with the Resources Filename of your placable.
#Exchange the (4) numbers after it sais "Vector" ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the placeable until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the placeable ,and start the game. When you arrive at the specific Area in game, the Placeable will be there.

'''Note:''' This method prevents removal of the placable. Check out a Plot driven method.

== Adding a NPC into an existing Area ==

'''M2DA Setup:'''

#AreaListName must be "any". This Script is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
// this is the name of a precreated plot file "joblos_quest" prefixed with the special "plt_"
// "plt_" + quest name allows you to reference the flag names as constants.
#include "plt_joblos_quest"
#include "wrappers_h"

void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag(PLT_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
); //this semicolom was missing and caused errors

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

#Replace "joblos_quest" (3x) with the name of your Plot.
#Replace "JOBLO_ADDED_TO_TOWN" (2x) with a custom Flag you create in your Plot.
#Replace "lot100ar_lothering" with the Tag of an Area ,the NPC should spawn in.
#Replace "joblo.utc" with the filename of your [[Creature]].
#Exchange the (4) numbers ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the NPC until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the creature ,and start the game. When you arrive at the specific Area in game, the [[Creature]] (Monsters or NPCs alike) will be there.

== Activating a Waypoint on the Worldmap ==

'''Requirements:''' Your module must extend Single Player.

'''M2DA Setup:'''

#AreaListName must be "any". Because Waypoint activation should be universal and it is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
const string WML_WOW_Custom = "eshmeswp";
#include "plt_mnp000pt_main_events"
#include "wrappers_h"
void main()
{
if(WR_GetPlotFlag( PLT_MNP000PT_MAIN_EVENTS, ARCHDEMON_EVENT_ONE) == TRUE )
{
WR_SetWorldMapLocationStatus(GetObjectByTag(WML_WOW_Custom), WM_LOCATION_ACTIVE);
}
}
</dascript>

#Replace "eshmeswp" in the 1st line with the "Tag" of your Waypoint (Map Pin) which u created. That Map Pin can be greyed out or inactive or so. Map Pin information can be found at: [[Map]].

Export the script, the Map ,and start the game. The Waypoint will now be activated once you leave Lothering, just like the other main Waypoints. This is to get in line with the Story. However to change the time of it happening..

#Choose which [[Plot]] should activate the Waypoint. The above example uses the Archdemon quest, when your nightmare triggers for example.
#Exchange "mnp000pt_main_events" in the 2nd and 6th line with the name of that other [[Plot]]. Leaving the "plt_" there.
#Exchange "ARCHDEMON_EVENT_ONE" with a "Flag" of your choice from that Plot.

This "should" work for any plot. Actually, waypoints dont need all this PRCSCR stuff and can be set "Active" in the first place. But the above example is to get in line with the Main Campaign, and potential gamebreaking Plot conflicts if able to leave Lothering too early.

== Adding an Item into the Players Inventory ==

'''Requirements:'''

'''M2DA Setup:'''
#AreaListName is "any".
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
//include utility_h for the UT_AddItemToInventory() function.
#include "utility_h"
//include the custom made plot file
#include "plt_$plot_file_name$"

void main()
{
// If plot flag is TRUE then item already given.
// Otherwise add item to inventory.
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == FALSE )
{
UT_AddItemToInventory(R"$item_file_name$.uti");
//Set the plot flag to TRUE to indicate that the item was given.
WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>
# Replace everything between and including the $ signs with appropriate names (without the file extensions).

== Adding an Item to an existing Vendor/Container ==

'''Requirements:'''

'''M2DA Setup:'''

#Origins (Bodahn) - AreaListName should be "cam100ar_camp_plains".
#Origins (daytime King's Camp vendor) - AreaListName should be "pre01al_kings_camp".
#Awakening (Yuriah or Personal Chest) - AreaListName should be "vgk210ar_throne_room".
#Leliana's Song (first Lem encounter) - AreaListName should be "lel100ar_market".
#Copy the GDA into your module's override folder (AddIns\{YourMod}\core\override)

'''Script:'''

<dascript>
#include "wrappers_h"
#include "plt_$plot_file_name$" // include your custom plot

void main()
{
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == TRUE ) return;

object oStore = GetObjectByTag("store_camp_bodahn"); // use this one for Origins/Bodahn
object oStore = GetObjectByTag("pre100sr_quartermaster"); // use this one for Origins/daytime King's Camp vendor
object oStore = GetObjectByTag("store_vgk100cr_merchant"); // use this one for Awakening/Yuriah
object oStore = GetObjectByTag("vgk210ip_party_chest"); // use this one for Awakening/Peronsal Chest
object oStore = GetObjectByTag("store_lel00cr_lem"); // use this one for Leliana's Song/first Lem encounter

if (IsObjectValid(oStore))
{
CreateItemOnObject(R"$resource_name$.uti", oStore, 1, "", TRUE); // repeat this for each item

WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>

#Replace "$plot_file_name$" and "$check_flag_name$" with the custom [[Plot#Scripting|plot and plot flags]] you create for your module.
#Replace "$resource_name$" with the resource name of your custom item.
#The very first time you go to the party camp in Origins (after leaving Lothering) and view the Archdemon cutscene, this script will NOT run. This is because the cutscene version of the camp is actually a different area. In this case you must exit and return to the "normal" (non-cutscene) party camp for the script to run for the first time.

== Adding a Working Door into an existing Area ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

== Adding a Quest to an existing Chanters Board ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

[[category:tutorials]]
[[Category:Scripts]]
[[Category:Pages with example scripts]]

EVENT TYPE UNEQUIP

2010-08-09T10:19:50Z

Nezroy: changed in 1.04

{{event
|sourcefile=script.ldf
|when= The current creature has unequipped an item
|from= [[engine]]
|to= [[creature]]s
|tocategory1=creature
|sortkey=UNEQUIP
|creatorname=oCreator
|creatordesc=creature doing the unequipping
|object0name=oItem
|object0desc=item being unequipped
|int0name=nInventorySlot
}}

Talk:EVENT TYPE UNEQUIP

2010-08-09T10:18:16Z

Nezroy: change in 1.04

It appears that the behavior of EVENT_TYPE_UNEQUIP has changed in patch 1.04.

Prior to patch 1.04, calling GetEventCreator on this event would return the item being unequipped. Getting the event object at index 0 returned either the item being unequipped or nothing, I'm not sure.

In patch 1.04, calling GetEventCreator on this event now returns the creature doing the unequipping . Getting the event object at index 0 returns the item being unequipped.

[[User:Nezroy|Nezroy]] 10:18, 9 August 2010 (UTC)

Module Resource Script.sql

2010-07-13T19:09:42Z

Nezroy: moving delete commentary to bottom

This script selects all of the resources for a module based on its UID. Change the UID in quotes (in the second line) to your module's UID.

<pre>
declare @modID int
set @modID = (select ID from dbo.t_Module as t where t.UID = 'my_module_UID')

-- tables using ModuleResRefVersionID (ModuleResRefVersionID = t_ModuleResRefVersion.ID)
select * from dbo.t_AreaWaypoint as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaSound as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaReverbVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaReverbVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaObjectVariable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaObjectGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaMusicVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaMusicVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaList as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaInstanceAssociations as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaAudioVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaAudioVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaAudioVolumeSound as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Area as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AssociatedResource as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Character as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ConversationTransition as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ConversationTagMap as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ConversationLine as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ConversationCinematics as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ConversationAnimations as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Conversation as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CreatureAbility as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Creature as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CutsceneTrack as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CutsceneObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CutsceneActionTransition as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CutsceneActionFBEParameter as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CutsceneAction as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Cutscene as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Inventory as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ItemProperty as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Item as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_MapTrailPoint as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_MapTrail as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_MapPin as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Map as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_MerchantRestrictedItem as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Merchant as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Placeable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_PlotStatus as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_PlotAssist as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Plot as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Role as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Script_Reference as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Script as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_StageObjectReference as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_StageObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_StageFBEParameter as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Stage as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_StringText as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_StringVersion as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Trigger as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Variable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)

-- resource refs
select * from dbo.t_ResRef as t, dbo.t_ModuleResRef as m where t.ID = m.ResRefId and m.ModuleID = @modID

-- tables using ModuleID (ModuleID = t_Module.ID)
select * from dbo.t_ModuleVariable as t where t.ModuleID = @modID
select * from dbo.t_ModuleResRef as t where t.ModuleID = @modID
select * from dbo.t_ModuleResRefVersion as t where t.ModuleID = @modID or t.OwnerModuleID = @modID

-- module tables
select * from dbo.t_ModuleAssociation as t where t.ChildModuleID = @modID or t.ParentModuleID = @modID
select * from dbo.t_String as t, dbo.t_Module as m where t.StringTableID = m.StringTableID and m.ID = @modID
select * from dbo.t_StringTable as t, dbo.t_Module as m where t.ID = m.StringTableID and m.ID = @modID
select * from dbo.t_Module as t where t.ID = @modID
</pre>

You could also use this script to delete a module completely from the DB by changing all of the "select * from dbo.t_table" statements to "delete dbo.t_table from dbo.t_table". Use this is at your own risk, however, as it is not fully tested. It's probably a good idea to back up your DB before trying that. Also, you'll need to add a line near the beginning to null out some of the module scripts to avoid foreign key issues:

<pre>update dbo.t_Module set StartAreaResRefID = NULL, ScriptResRefID = NULL, ClientScriptResRefID = NULL where ID = @modID</pre>

Module Resource Script.sql

2010-07-13T19:05:02Z

Nezroy: adding string table

This script selects all of the resources for a module based on its UID. Change the UID in quotes (in the second line) to your module's UID.

You could also use this script to delete a module completely from the DB by changing all of the "select *" statements to "delete". Use this is at your own risk, however, as it is not fully tested. It's probably a good idea to back up your DB before trying that.

<pre>
declare @modID int
set @modID = (select ID from dbo.t_Module as t where t.UID = 'nez_shdwrdncmdr')

-- tables using ModuleResRefVersionID (ModuleResRefVersionID = t_ModuleResRefVersion.ID)
select * from dbo.t_AreaWaypoint as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaSound as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaReverbVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaReverbVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaObjectVariable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaObjectGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaMusicVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaMusicVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaList as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaInstanceAssociations as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaAudioVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaAudioVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AreaAudioVolumeSound as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Area as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_AssociatedResource as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Character as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ConversationTransition as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ConversationTagMap as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ConversationLine as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ConversationCinematics as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ConversationAnimations as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Conversation as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CreatureAbility as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Creature as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CutsceneTrack as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CutsceneObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CutsceneActionTransition as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CutsceneActionFBEParameter as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_CutsceneAction as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Cutscene as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Inventory as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_ItemProperty as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Item as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_MapTrailPoint as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_MapTrail as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_MapPin as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Map as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_MerchantRestrictedItem as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Merchant as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Placeable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_PlotStatus as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_PlotAssist as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Plot as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Role as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Script_Reference as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Script as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_StageObjectReference as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_StageObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_StageFBEParameter as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Stage as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_StringText as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_StringVersion as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Trigger as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)
select * from dbo.t_Variable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and (m.ModuleID = @modID or m.OwnerModuleID = @modID)

-- resource refs
select * from dbo.t_ResRef as t, dbo.t_ModuleResRef as m where t.ID = m.ResRefId and m.ModuleID = @modID

-- tables using ModuleID (ModuleID = t_Module.ID)
select * from dbo.t_ModuleVariable as t where t.ModuleID = @modID
select * from dbo.t_ModuleResRef as t where t.ModuleID = @modID
select * from dbo.t_ModuleResRefVersion as t where t.ModuleID = @modID or t.OwnerModuleID = @modID

-- module tables
select * from dbo.t_ModuleAssociation as t where t.ChildModuleID = @modID or t.ParentModuleID = @modID
select * from dbo.t_String as t, dbo.t_Module as m where t.StringTableID = m.StringTableID and m.ID = @modID
select * from dbo.t_StringTable as t, dbo.t_Module as m where t.ID = m.StringTableID and m.ID = @modID
select * from dbo.t_Module as t where t.ID = @modID
</pre>

Module Resource Script.sql

2010-07-13T19:02:55Z

Nezroy: including ownermoduleid in resref lookup

Feature request: Deleting a module

2010-07-13T18:43:04Z

Nezroy: /* Deleting a Module from the Toolset */ alternate SQL to avoid orphans

The current toolset does not allow for the deletion of a module that has been created.
Users typically initially create a bunch of test modules that cannot be removed, and forever after clutter up the list of modules.

There is a hacky workaround of deleting the module name manually from the database, but it just orphans all the modules resources without removing them from the database.

{{EV|210854|[[User:Allan Smith|Allan Smith]]}}

Beware, this is by no means a clean and easy solution.

== 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 table on the dbo.Module 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 delete out the resources within the toolset before you remove the module reference you should avoid this.

=== Alternate SQL to Avoid Orphans ===

Instead of removing only the entry from the dbo.t_Module table as described above, you can modify the [[Module_Resource_Script.sql|module resource SQL script]] to delete instead of select. This should clean up all of your module resources cleanly, but is a higher risk approach since you could accidentally delete more than you intended.

[[Category:Feature requests]]
[[Category:Modules]]

Module Resource Script.sql

2010-07-13T18:39:37Z

Nezroy: changing default mod UID for clarity

This script selects all of the resources for a module based on its UID. Change the UID in quotes (in the second line) to your module's UID.

You could also use this script to delete a module completely from the DB by changing all of the "select *" statements to "delete". Use this is at your own risk, however, as it is not fully tested. It's probably a good idea to back up your DB before trying that.

<pre>
declare @modID int
set @modID = (select ID from dbo.t_Module as t where t.UID = 'my_module_UID')

-- tables using ModuleResRefVersionID (ModuleResRefVersionID = t_ModuleResRefVersion.ID)
select * from dbo.t_Area as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaAudioVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaAudioVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaAudioVolumeSound as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaInstanceAssociations as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaList as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaMusicVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaMusicVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaObjectGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaObjectVariable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaReverbVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaReverbVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaSound as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaWaypoint as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AssociatedResource as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Character as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Conversation as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ConversationAnimations as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ConversationCinematics as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ConversationLine as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ConversationTagMap as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ConversationTransition as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Creature as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CreatureAbility as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Cutscene as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CutsceneAction as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CutsceneActionFBEParameter as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CutsceneActionTransition as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CutsceneObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CutsceneTrack as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Inventory as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Item as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ItemProperty as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Map as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_MapPin as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_MapTrail as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_MapTrailPoint as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Merchant as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_MerchantRestrictedItem as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Placeable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Plot as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_PlotAssist as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_PlotStatus as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Role as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Script as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Script_Reference as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Stage as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_StageFBEParameter as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_StageObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_StageObjectReference as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_StringText as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_StringVersion as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Trigger as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Variable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID

-- resource refs
select * from dbo.t_ResRef as t, dbo.t_ModuleResRef as m where t.ID = m.ResRefId and m.ModuleID = @modID

-- tables using ModuleID (ModuleID = t_Module.ID)
select * from dbo.t_ModuleVariable as t where t.ModuleID = @modID
select * from dbo.t_ModuleResRef as t where t.ModuleID = @modID
select * from dbo.t_ModuleResRefVersion as t where t.ModuleID = @modID

-- module tables
select * from dbo.t_ModuleAssociation as t where t.ChildModuleID = @modID or t.ParentModuleID = @modID
select * from dbo.t_String as t, dbo.t_Module as m where t.StringTableID = m.StringTableID and m.ID = @modID
select * from dbo.t_Module as t where t.ID = @modID
</pre>

Module Resource Script.sql

2010-07-13T18:39:00Z

Nezroy: SQL script for selecting all module content

This script selects all of the resources for a module based on its UID. Change the UID in quotes (in the second line) to your module's UID.

You could also use this script to delete a module completely from the DB by changing all of the "select *" statements to "delete". Use this is at your own risk, however, as it is not fully tested. It's probably a good idea to back up your DB before trying that.

<pre>
declare @modID int
set @modID = (select ID from dbo.t_Module as t where t.UID = 'nez_shdwrdncmdr')

-- tables using ModuleResRefVersionID (ModuleResRefVersionID = t_ModuleResRefVersion.ID)
select * from dbo.t_Area as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaAudioVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaAudioVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaAudioVolumeSound as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaInstanceAssociations as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaList as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaMusicVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaMusicVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaObjectGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaObjectVariable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaReverbVolume as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaReverbVolumeGeometry as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaSound as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AreaWaypoint as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_AssociatedResource as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Character as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Conversation as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ConversationAnimations as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ConversationCinematics as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ConversationLine as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ConversationTagMap as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ConversationTransition as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Creature as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CreatureAbility as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Cutscene as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CutsceneAction as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CutsceneActionFBEParameter as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CutsceneActionTransition as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CutsceneObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_CutsceneTrack as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Inventory as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Item as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_ItemProperty as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Map as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_MapPin as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_MapTrail as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_MapTrailPoint as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Merchant as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_MerchantRestrictedItem as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Placeable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Plot as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_PlotAssist as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_PlotStatus as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Role as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Script as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Script_Reference as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Stage as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_StageFBEParameter as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_StageObject as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_StageObjectReference as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_StringText as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_StringVersion as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Trigger as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID
select * from dbo.t_Variable as t, dbo.t_ModuleResRefVersion as m where t.ModuleResRefVersionID = m.ID and m.ModuleID = @modID

-- resource refs
select * from dbo.t_ResRef as t, dbo.t_ModuleResRef as m where t.ID = m.ResRefId and m.ModuleID = @modID

-- tables using ModuleID (ModuleID = t_Module.ID)
select * from dbo.t_ModuleVariable as t where t.ModuleID = @modID
select * from dbo.t_ModuleResRef as t where t.ModuleID = @modID
select * from dbo.t_ModuleResRefVersion as t where t.ModuleID = @modID

-- module tables
select * from dbo.t_ModuleAssociation as t where t.ChildModuleID = @modID or t.ParentModuleID = @modID
select * from dbo.t_String as t, dbo.t_Module as m where t.StringTableID = m.StringTableID and m.ID = @modID
select * from dbo.t_Module as t where t.ID = @modID
</pre>

PRCSCR Script Templates

2010-06-17T22:28:59Z

Nezroy: /* Adding an Item to an existing Vendor */ clarifying where the GDA goes

This page serves as a repository for ready to use M2DA's and Scripts to use in conjunction with [[PRCSCR]] M2DA's when adding custom content to the game.

References:
*See Main Article: ''[[PRCSCR]]''
*See ''[[PRCSCR.xls]]'' for details about that M2DA, or ''[[2DA]]'' for an explanation of 2DA's as a whole
*To create a Script, right click in the Resourcepalette and select "New/Script" , or see ''[[Designer Resources]]'' for such Resources as a whole.


__NOTOC__
'''Contents:'''
{| style="background-color:#eeeeee; border:2px #999999 solid; padding:4px; margin:4px" border="3"
| width=300 |[[PRCSCR Script Templates#Adding a placeable into an existing Area|1. Adding a placeable into an existing Area]]
| width=800 |This Script serves to add a placeable of your choice into an Area of choice. ''(non removable)''
|-
| [[PRCSCR Script Templates#Adding a NPC into an existing Area|2. Adding a NPC into an existing Area]]
| This Script serves to any custom NPC or Creature to a Area of choice. ''(removable)''
|-
| [[PRCSCR Script Templates#Activating a Waypoint on the Worldmap|3. Activating a Waypoint on the Worldmap]]
| This Script serves to activate a custom Waypoint (Map Pin) of choice ,when leaving Lothering or at any other time into the Game.
|-
| [[PRCSCR Script Templates#Adding an Item into the Players Inventory|4. Adding an Item into the Players Inventory]]
| This Script serves to instantly add an Item into the Players Inventory.
|-
| [[PRCSCR Script Templates#Adding an Item to an existing Vendor|5. Adding an Item to an existing Vendor]]
| This Script serves to add any Item into a existing Vendors Inventory, as long the Vendor exists.
|-
| 6. Adding a Working Door into an existing Area
| This Script serves to add a custom Door into a existing Area, that the Player can enter into a custom Area.
|-
| 7. Adding a Quest to an existing Chanters Board
| This Script serves to add a new Quest to a existing Chanters Board, at any chosen time into the Game.
|-
| 8. ...
| ...
|}

== Adding a placeable into an existing Area ==

'''M2DA Setup:'''

#AreaListName must not be "any". Chose a specific one.
#Copy the GDA into your modules override folder.

'''Script:''' (As taken from the Storage Chest mod a kind Bioware employee made :o)

<dascript>
//const string TAL_STORAGE_CHEST_SPAWNED = "TAL_STORAGE_CHEST_SPAWNED";
const string TAL_IP_STORAGE_CHEST = "tal_ip_storage_chest";
const resource TAL_RESOURCE_IP_STORAGE_CHEST = R"tal_ip_storage_chest.utp";

void main()
{
object oMainControlled = GetMainControlled();
object oChest = UT_GetNearestObjectByTag(oMainControlled, TAL_IP_STORAGE_CHEST);

//DisplayFloatyMessage(oMainControlled, "storage script working", FLOATY_MESSAGE, 16777215, 30.0);

if (!IsObjectValid(oChest))
{
location lSpawn = Location(GetArea(oMainControlled), Vector(148.77, 117.68, -0.94), 0.0);
CreateObject(OBJECT_TYPE_PLACEABLE, TAL_RESOURCE_IP_STORAGE_CHEST, lSpawn);

//DisplayFloatyMessage(oMainControlled, "storage chest created", FLOATY_MESSAGE, 16777215, 30.0);
}
}
</dascript>

#Replace "tal_ip_storage_chest" in the 2nd line with the "Tag" of your own placeable. (only small letters allowed)
#Replace "tal_ip_storage_chest.utp" in 3rd line with the Resources Filename of your placable.
#Exchange the (4) numbers after it sais "Vector" ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the placeable until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the placeable ,and start the game. When you arrive at the specific Area in game, the Placeable will be there.

'''Note:''' This method prevents removal of the placable. Check out a Plot driven method.

== Adding a NPC into an existing Area ==

'''M2DA Setup:'''

#AreaListName must be "any". This Script is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
// this is the name of a precreated plot file "joblos_quest" prefixed with the special "plt_"
// "plt_" + quest name allows you to reference the flag names as constants.
#include "plt_joblos_quest"
#include "wrappers_h"

void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag(PLT_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
); //this semicolom was missing and caused errors

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

#Replace "joblos_quest" (3x) with the name of your Plot.
#Replace "JOBLO_ADDED_TO_TOWN" (2x) with a custom Flag you create in your Plot.
#Replace "lot100ar_lothering" with the Tag of an Area ,the NPC should spawn in.
#Replace "joblo.utc" with the filename of your [[Creature]].
#Exchange the (4) numbers ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the NPC until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the creature ,and start the game. When you arrive at the specific Area in game, the [[Creature]] (Monsters or NPCs alike) will be there.

== Activating a Waypoint on the Worldmap ==

'''Requirements:''' Your module must extend Single Player.

'''M2DA Setup:'''

#AreaListName must be "any". Because Waypoint activation should be universal and it is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
const string WML_WOW_Custom = "eshmeswp";
#include "plt_mnp000pt_main_events"
#include "wrappers_h"
void main()
{
if(WR_GetPlotFlag( PLT_MNP000PT_MAIN_EVENTS, ARCHDEMON_EVENT_ONE) == TRUE )
{
WR_SetWorldMapLocationStatus(GetObjectByTag(WML_WOW_Custom), WM_LOCATION_ACTIVE);
}
}
</dascript>

#Replace "eshmeswp" in the 1st line with the "Tag" of your Waypoint (Map Pin) which u created. That Map Pin can be greyed out or inactive or so. Map Pin information can be found at: [[Map]].

Export the script, the Map ,and start the game. The Waypoint will now be activated once you leave Lothering, just like the other main Waypoints. This is to get in line with the Story. However to change the time of it happening..

#Choose which [[Plot]] should activate the Waypoint. The above example uses the Archdemon quest, when your nightmare triggers for example.
#Exchange "mnp000pt_main_events" in the 2nd and 6th line with the name of that other [[Plot]]. Leaving the "plt_" there.
#Exchange "ARCHDEMON_EVENT_ONE" with a "Flag" of your choice from that Plot.

This "should" work for any plot. Actually, waypoints dont need all this PRCSCR stuff and can be set "Active" in the first place. But the above example is to get in line with the Main Campaign, and potential gamebreaking Plot conflicts if able to leave Lothering too early.

== Adding an Item into the Players Inventory ==

'''Requirements:'''

'''M2DA Setup:'''
#AreaListName is "any".
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
//include utility_h for the UT_AddItemToInventory() function.
#include "utility_h"
//include the custom made plot file
#include "plt_$plot_file_name$"

void main()
{
// If plot flag is TRUE then item already given.
// Otherwise add item to inventory.
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == FALSE )
{
UT_AddItemToInventory(R"$item_file_name$.uti");
//Set the plot flag to TRUE to indicate that the item was given.
WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>
# Replace everything between and including the $ signs with appropriate names (without the file extensions).

== Adding an Item to an existing Vendor ==

'''Requirements:'''

'''M2DA Setup:'''

#Origins (Bodahn) - AreaListName should be "cam100ar_camp_plains".
#Awakening (Yuriah) - AreaListName should be "vgk210ar_throne_room".
#Copy the GDA into your module's override folder (AddIns\{YourMod}\core\override)

'''Script:'''

<dascript>
#include "wrappers_h"
#include "plt_$plot_file_name$" // include your custom plot

void main()
{
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == TRUE ) return;

object oStore = GetObjectByTag("store_camp_bodahn"); // use this one for Bodahn/Origins
object oStore = GetObjectByTag("store_vgk100cr_merchant"); // use this one for Yuriah/Awakening

if (IsObjectValid(oStore))
{
CreateItemOnObject(R"$resource_name$.uti", oStore, 1, "", TRUE); // repeat this for each item

WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>

#Replace "$plot_file_name$" and "$check_flag_name$" with the custom [[Plot#Scripting|plot and plot flags]] you create for your module.
#Replace "$resource_name$" with the resource name of your custom item.
#The very first time you go to the party camp in Origins (after leaving Lothering) and view the Archdemon cutscene, this script will NOT run. This is because the cutscene version of the camp is actually a different area. In this case you must exit and return to the "normal" (non-cutscene) party camp for the script to run for the first time.

== Adding a Working Door into an existing Area ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

== Adding a Quest to an existing Chanters Board ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

[[category:tutorials]]
[[Category:Scripts]]
[[Category:Pages with example scripts]]

DDS Export Settings

2010-06-15T19:41:30Z

Nezroy:

== nvdxt.exe ==

The toolset comes with a copy of the NVidia command line tool nvdxt.exe. This tool converts TGA files into DDS files, and can be found at "Dragon Age Origins\tools\ResourceBuild\Processors\nvdxt.exe".

A typical nvdxt.exe call looks like this:

<code>nvdxt.exe [format] -quality_highest -file input.tga -output output.dds</code>

The [format] portion would be replaced by options that depend on the specific texture types.

=== For Icons ===

Replace [format] with: <code>-u8888 -nomipmap</code>

=== For Diffuse Textures ===

Replace [format] with: <code>-dxt1</code>

=== For Specular/Tint/Normal Textures ===

Replace [format] with: <code>-dxt5</code>

NOTE: <code>-dxt3</code> should also work, and may produce better quality textures under certain conditions.

=== LOD/prescale ===

Another useful option is <code>-prescale x y</code>, with x and y specifying pixel dimensions. This resizes the texture to the specified size before generating the DDS. This can be very useful for creating the necessary multiple LOD textures from a single large source TGA.

== Photoshop Plugin ==

(compiled from http://social.bioware.com/forum/1/topic/8/index/599061/1#604952)

=== For Icons ===
According to [http://social.bioware.com/10507/ Ketaros] <blockquote>
Format: "X.8.8.8 XRGB 32 bpp | unsigned" 
Type: "2D Texture" 
Choose: "No MIP maps" </blockquote>

According to [http://social.bioware.com/112329/ tmp7704
<blockquote>
"The icons i've extracted from original files were saved in ARGB fromat with fully opaque Alpha channel. Saving the data in XRGB format theoretically skips the alpha channel data altogether and supplies one unused channel instead, no idea if that makes any difference for the game engine." </blockquote>

According to [http://social.bioware.com/737222/ theBigMuh] <blockquote>
Format 8.8.8.8 ARGB 
Type: "2D Texture" (not qouted but assumed) 
Choose: "No mip maps" </blockquote>

=== For Textures ===
According to [http://social.bioware.com/737222/ theBigMuh]
<blockquote>
"For textures, use DXT1 for diffuse\\specular\\tint, and DXT3 (NOT DXT5) for normal maps. The interpolated alpha of DXT5 makes for horrible horrible bump mapping artifacts. Check generate mip maps, too. Put the high resolution variation into AddIns\\<youraddin>\\core\\textures\\high, and a 50% downscaled version into AddIns\\<youraddin>\\core\\textures\\medium." </blockquote>

According to [http://social.bioware.com/112329/ tmp7704]
<blockquote>
"The 1-bit alpha channel in DXT1 compression is often going to mess things up or be simply insufficient.

The native tint maps seem to use unsigned 16-bit format (a4r4g4b4) which works for them since they don't use any real gradients to speak of.

The choice between DXT3 and DXT5 for the normal maps would depend on what sort of data is put in the alpha channel. If it has smooth gradients DXT5 is better suited for it. For sharp transitions DXT3 may be a better choice (the limitation of DXT3 compression is it can only record 16 brightness steps rather than 256. While DXT5 is similar to it in the worst possible case, it can offer better fidelity when your alpha channel doesn't cover full 0-255 brightness range)"</blockquote>

== See Also ==
[[DDS]]

[[Texture Formats]]

[[Category:Textures]]

DDS Export Settings

2010-06-15T19:40:49Z

Nezroy: relocating thread link

== nvdxt.exe ==

The toolset comes with a copy of the NVidia command line tool nvdxt.exe. This tool converts TGA files into DDS files, and can be found at "Dragon Age Origins\tools\ResourceBuild\Processors\nvdxt.exe".

A typical nvdxt.exe call looks like this:

<code>nvdxt.exe [format] -quality_highest -file input.tga -output output.dds</code>

The [format] portion would be replaced by options that depend on the specific texture types.

=== For Icons ===

Replace [format] with: <code>-u8888 -nomipmap</code>

=== For Diffuse Textures ===

Replace [format] with: <code>-dxt1</code>

=== For Specular/Tint Textures ===

Replace [format] with: <code>-dxt5</code>

NOTE: <code>-dxt3</code> should also work, and may produce better quality textures under certain conditions.

=== LOD/prescale ===

Another useful option is <code>-prescale x y</code>, with x and y specifying pixel dimensions. This resizes the texture to the specified size before generating the DDS. This can be very useful for creating the necessary multiple LOD textures from a single large source TGA.

== Photoshop Plugin ==

(compiled from http://social.bioware.com/forum/1/topic/8/index/599061/1#604952)

=== For Icons ===
According to [http://social.bioware.com/10507/ Ketaros] <blockquote>
Format: "X.8.8.8 XRGB 32 bpp | unsigned" 
Type: "2D Texture" 
Choose: "No MIP maps" </blockquote>

According to [http://social.bioware.com/112329/ tmp7704
<blockquote>
"The icons i've extracted from original files were saved in ARGB fromat with fully opaque Alpha channel. Saving the data in XRGB format theoretically skips the alpha channel data altogether and supplies one unused channel instead, no idea if that makes any difference for the game engine." </blockquote>

According to [http://social.bioware.com/737222/ theBigMuh] <blockquote>
Format 8.8.8.8 ARGB 
Type: "2D Texture" (not qouted but assumed) 
Choose: "No mip maps" </blockquote>

=== For Textures ===
According to [http://social.bioware.com/737222/ theBigMuh]
<blockquote>
"For textures, use DXT1 for diffuse\\specular\\tint, and DXT3 (NOT DXT5) for normal maps. The interpolated alpha of DXT5 makes for horrible horrible bump mapping artifacts. Check generate mip maps, too. Put the high resolution variation into AddIns\\<youraddin>\\core\\textures\\high, and a 50% downscaled version into AddIns\\<youraddin>\\core\\textures\\medium." </blockquote>

According to [http://social.bioware.com/112329/ tmp7704]
<blockquote>
"The 1-bit alpha channel in DXT1 compression is often going to mess things up or be simply insufficient.

The native tint maps seem to use unsigned 16-bit format (a4r4g4b4) which works for them since they don't use any real gradients to speak of.

The choice between DXT3 and DXT5 for the normal maps would depend on what sort of data is put in the alpha channel. If it has smooth gradients DXT5 is better suited for it. For sharp transitions DXT3 may be a better choice (the limitation of DXT3 compression is it can only record 16 brightness steps rather than 256. While DXT5 is similar to it in the worst possible case, it can offer better fidelity when your alpha channel doesn't cover full 0-255 brightness range)"</blockquote>

== See Also ==
[[DDS]]

[[Texture Formats]]

[[Category:Textures]]

DDS Export Settings

2010-06-15T19:39:17Z

Nezroy: adding nvdxt.exe settings

According to http://social.bioware.com/forum/1/topic/8/index/599061/1#604952 these are the DDS export settings one should use.

== nvdxt.exe ==

The toolset comes with a copy of the NVidia command line tool nvdxt.exe. This tool converts TGA files into DDS files, and can be found at "Dragon Age Origins\tools\ResourceBuild\Processors\nvdxt.exe".

A typical nvdxt.exe call looks like this:

<code>nvdxt.exe [format] -quality_highest -file input.tga -output output.dds</code>

The [format] portion would be replaced by options that depend on the specific texture types.

=== For Icons ===

Replace [format] with: <code>-u8888 -nomipmap</code>

=== For Diffuse Textures ===

Replace [format] with: <code>-dxt1</code>

=== For Specular/Tint Textures ===

Replace [format] with: <code>-dxt5</code>

NOTE: <code>-dxt3</code> should also work, and may produce better quality textures under certain conditions.

=== LOD/prescale ===

Another useful option is <code>-prescale x y</code>, with x and y specifying pixel dimensions. This resizes the texture to the specified size before generating the DDS. This can be very useful for creating the necessary multiple LOD textures from a single large source TGA.

== Photoshop Plugin ==

=== For Icons ===
According to [http://social.bioware.com/10507/ Ketaros] <blockquote>
Format: "X.8.8.8 XRGB 32 bpp | unsigned" 
Type: "2D Texture" 
Choose: "No MIP maps" </blockquote>

According to [http://social.bioware.com/112329/ tmp7704
<blockquote>
"The icons i've extracted from original files were saved in ARGB fromat with fully opaque Alpha channel. Saving the data in XRGB format theoretically skips the alpha channel data altogether and supplies one unused channel instead, no idea if that makes any difference for the game engine." </blockquote>

According to [http://social.bioware.com/737222/ theBigMuh] <blockquote>
Format 8.8.8.8 ARGB 
Type: "2D Texture" (not qouted but assumed) 
Choose: "No mip maps" </blockquote>

=== For Textures ===
According to [http://social.bioware.com/737222/ theBigMuh]
<blockquote>
"For textures, use DXT1 for diffuse\\specular\\tint, and DXT3 (NOT DXT5) for normal maps. The interpolated alpha of DXT5 makes for horrible horrible bump mapping artifacts. Check generate mip maps, too. Put the high resolution variation into AddIns\\<youraddin>\\core\\textures\\high, and a 50% downscaled version into AddIns\\<youraddin>\\core\\textures\\medium." </blockquote>

According to [http://social.bioware.com/112329/ tmp7704]
<blockquote>
"The 1-bit alpha channel in DXT1 compression is often going to mess things up or be simply insufficient.

The native tint maps seem to use unsigned 16-bit format (a4r4g4b4) which works for them since they don't use any real gradients to speak of.

The choice between DXT3 and DXT5 for the normal maps would depend on what sort of data is put in the alpha channel. If it has smooth gradients DXT5 is better suited for it. For sharp transitions DXT3 may be a better choice (the limitation of DXT3 compression is it can only record 16 brightness steps rather than 256. While DXT5 is similar to it in the worst possible case, it can offer better fidelity when your alpha channel doesn't cover full 0-255 brightness range)"</blockquote>

== See Also ==
[[DDS]]

[[Texture Formats]]

[[Category:Textures]]

PRCSCR Script Templates

2010-05-27T17:10:11Z

Nezroy: /* Adding an Item to an existing Vendor */

This page serves as a repository for ready to use M2DA's and Scripts to use in conjunction with [[PRCSCR]] M2DA's when adding custom content to the game.

References:
*See Main Article: ''[[PRCSCR]]''
*See ''[[PRCSCR.xls]]'' for details about that M2DA, or ''[[2DA]]'' for an explanation of 2DA's as a whole
*To create a Script, right click in the Resourcepalette and select "New/Script" , or see ''[[Designer Resources]]'' for such Resources as a whole.


__NOTOC__
'''Contents:'''
{| style="background-color:#eeeeee; border:2px #999999 solid; padding:4px; margin:4px" border="3"
| width=300 |[[PRCSCR Script Templates#Adding a placeable into an existing Area|1. Adding a placeable into an existing Area]]
| width=800 |This Script serves to add a placeable of your choice into an Area of choice. ''(non removable)''
|-
| [[PRCSCR Script Templates#Adding a NPC into an existing Area|2. Adding a NPC into an existing Area]]
| This Script serves to any custom NPC or Creature to a Area of choice. ''(removable)''
|-
| [[PRCSCR Script Templates#Activating a Waypoint on the Worldmap|3. Activating a Waypoint on the Worldmap]]
| This Script serves to activate a custom Waypoint (Map Pin) of choice ,when leaving Lothering or at any other time into the Game.
|-
| [[PRCSCR Script Templates#Adding an Item into the Players Inventory|4. Adding an Item into the Players Inventory]]
| This Script serves to instantly add an Item into the Players Inventory.
|-
| [[PRCSCR Script Templates#Adding an Item to an existing Vendor|5. Adding an Item to an existing Vendor]]
| This Script serves to add any Item into a existing Vendors Inventory, as long the Vendor exists.
|-
| 6. Adding a Working Door into an existing Area
| This Script serves to add a custom Door into a existing Area, that the Player can enter into a custom Area.
|-
| 7. Adding a Quest to an existing Chanters Board
| This Script serves to add a new Quest to a existing Chanters Board, at any chosen time into the Game.
|-
| 8. ...
| ...
|}

== Adding a placeable into an existing Area ==

'''M2DA Setup:'''

#AreaListName must not be "any". Chose a specific one.
#Copy the GDA into your modules override folder.

'''Script:''' (As taken from the Storage Chest mod a kind Bioware employee made :o)

<dascript>
//const string TAL_STORAGE_CHEST_SPAWNED = "TAL_STORAGE_CHEST_SPAWNED";
const string TAL_IP_STORAGE_CHEST = "tal_ip_storage_chest";
const resource TAL_RESOURCE_IP_STORAGE_CHEST = R"tal_ip_storage_chest.utp";

void main()
{
object oMainControlled = GetMainControlled();
object oChest = UT_GetNearestObjectByTag(oMainControlled, TAL_IP_STORAGE_CHEST);

//DisplayFloatyMessage(oMainControlled, "storage script working", FLOATY_MESSAGE, 16777215, 30.0);

if (!IsObjectValid(oChest))
{
location lSpawn = Location(GetArea(oMainControlled), Vector(148.77, 117.68, -0.94), 0.0);
CreateObject(OBJECT_TYPE_PLACEABLE, TAL_RESOURCE_IP_STORAGE_CHEST, lSpawn);

//DisplayFloatyMessage(oMainControlled, "storage chest created", FLOATY_MESSAGE, 16777215, 30.0);
}
}
</dascript>

#Replace "tal_ip_storage_chest" in the 2nd line with the "Tag" of your own placeable. (only small letters allowed)
#Replace "tal_ip_storage_chest.utp" in 3rd line with the Resources Filename of your placable.
#Exchange the (4) numbers after it sais "Vector" ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the placeable until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the placeable ,and start the game. When you arrive at the specific Area in game, the Placeable will be there.

'''Note:''' This method prevents removal of the placable. Check out a Plot driven method.

== Adding a NPC into an existing Area ==

'''M2DA Setup:'''

#AreaListName must be "any". This Script is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
// this is the name of a precreated plot file "joblos_quest" prefixed with the special "plt_"
// "plt_" + quest name allows you to reference the flag names as constants.
#include "plt_joblos_quest"
#include "wrappers_h"

void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag(PLT_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
); //this semicolom was missing and caused errors

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

#Replace "joblos_quest" (3x) with the name of your Plot.
#Replace "JOBLO_ADDED_TO_TOWN" (2x) with a custom Flag you create in your Plot.
#Replace "lot100ar_lothering" with the Tag of an Area ,the NPC should spawn in.
#Replace "joblo.utc" with the filename of your [[Creature]].
#Exchange the (4) numbers ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the NPC until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the creature ,and start the game. When you arrive at the specific Area in game, the [[Creature]] (Monsters or NPCs alike) will be there.

== Activating a Waypoint on the Worldmap ==

'''Requirements:''' Your module must extend Single Player.

'''M2DA Setup:'''

#AreaListName must be "any". Because Waypoint activation should be universal and it is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
const string WML_WOW_Custom = "eshmeswp";
#include "plt_mnp000pt_main_events"
#include "wrappers_h"
void main()
{
if(WR_GetPlotFlag( PLT_MNP000PT_MAIN_EVENTS, ARCHDEMON_EVENT_ONE) == TRUE )
{
WR_SetWorldMapLocationStatus(GetObjectByTag(WML_WOW_Custom), WM_LOCATION_ACTIVE);
}
}
</dascript>

#Replace "eshmeswp" in the 1st line with the "Tag" of your Waypoint (Map Pin) which u created. That Map Pin can be greyed out or inactive or so. Map Pin information can be found at: [[Map]].

Export the script, the Map ,and start the game. The Waypoint will now be activated once you leave Lothering, just like the other main Waypoints. This is to get in line with the Story. However to change the time of it happening..

#Choose which [[Plot]] should activate the Waypoint. The above example uses the Archdemon quest, when your nightmare triggers for example.
#Exchange "mnp000pt_main_events" in the 2nd and 6th line with the name of that other [[Plot]]. Leaving the "plt_" there.
#Exchange "ARCHDEMON_EVENT_ONE" with a "Flag" of your choice from that Plot.

This "should" work for any plot. Actually, waypoints dont need all this PRCSCR stuff and can be set "Active" in the first place. But the above example is to get in line with the Main Campaign, and potential gamebreaking Plot conflicts if able to leave Lothering too early.

== Adding an Item into the Players Inventory ==

'''Requirements:'''

'''M2DA Setup:'''
#AreaListName is "any".
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
//include utility_h for the UT_AddItemToInventory() function.
#include "utility_h"
//include the custom made plot file
#include "plt_$plot_file_name$"

void main()
{
// If plot flag is TRUE then item already given.
// Otherwise add item to inventory.
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == FALSE )
{
UT_AddItemToInventory(R"$item_file_name$.uti");
//Set the plot flag to TRUE to indicate that the item was given.
WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>
# Replace everything between and including the $ signs with appropriate names (without the file extensions).

== Adding an Item to an existing Vendor ==

'''Requirements:'''

'''M2DA Setup:'''

#Origins (Bodahn) - AreaListName should be "cam100ar_camp_plains".
#Awakening (Yuriah) - AreaListName should be "vgk210ar_throne_room".
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
#include "wrappers_h"
#include "plt_$plot_file_name$" // include your custom plot

void main()
{
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == TRUE ) return;

object oStore = GetObjectByTag("store_camp_bodahn"); // use this one for Bodahn/Origins
object oStore = GetObjectByTag("store_vgk100cr_merchant"); // use this one for Yuriah/Awakening

if (IsObjectValid(oStore))
{
CreateItemOnObject(R"$resource_name$.uti", oStore, 1, "", TRUE); // repeat this for each item

WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>

#Replace "$plot_file_name$" and "$check_flag_name$" with the custom [[Plot#Scripting|plot and plot flags]] you create for your module.
#Replace "$resource_name$" with the resource name of your custom item.
#The very first time you go to the party camp in Origins (after leaving Lothering) and view the Archdemon cutscene, this script will NOT run. This is because the cutscene version of the camp is actually a different area. In this case you must exit and return to the "normal" (non-cutscene) party camp for the script to run for the first time.

== Adding a Working Door into an existing Area ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

== Adding a Quest to an existing Chanters Board ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

[[category:tutorials]]
[[Category:Scripts]]
[[Category:Pages with example scripts]]

PRCSCR Script Templates

2010-05-27T15:46:05Z

Nezroy: /* Adding an Item to an existing Vendor */

This page serves as a repository for ready to use M2DA's and Scripts to use in conjunction with [[PRCSCR]] M2DA's when adding custom content to the game.

References:
*See Main Article: ''[[PRCSCR]]''
*See ''[[PRCSCR.xls]]'' for details about that M2DA, or ''[[2DA]]'' for an explanation of 2DA's as a whole
*To create a Script, right click in the Resourcepalette and select "New/Script" , or see ''[[Designer Resources]]'' for such Resources as a whole.


__NOTOC__
'''Contents:'''
{| style="background-color:#eeeeee; border:2px #999999 solid; padding:4px; margin:4px" border="3"
| width=300 |[[PRCSCR Script Templates#Adding a placeable into an existing Area|1. Adding a placeable into an existing Area]]
| width=800 |This Script serves to add a placeable of your choice into an Area of choice. ''(non removable)''
|-
| [[PRCSCR Script Templates#Adding a NPC into an existing Area|2. Adding a NPC into an existing Area]]
| This Script serves to any custom NPC or Creature to a Area of choice. ''(removable)''
|-
| [[PRCSCR Script Templates#Activating a Waypoint on the Worldmap|3. Activating a Waypoint on the Worldmap]]
| This Script serves to activate a custom Waypoint (Map Pin) of choice ,when leaving Lothering or at any other time into the Game.
|-
| [[PRCSCR Script Templates#Adding an Item into the Players Inventory|4. Adding an Item into the Players Inventory]]
| This Script serves to instantly add an Item into the Players Inventory.
|-
| [[PRCSCR Script Templates#Adding an Item to an existing Vendor|5. Adding an Item to an existing Vendor]]
| This Script serves to add any Item into a existing Vendors Inventory, as long the Vendor exists.
|-
| 6. Adding a Working Door into an existing Area
| This Script serves to add a custom Door into a existing Area, that the Player can enter into a custom Area.
|-
| 7. Adding a Quest to an existing Chanters Board
| This Script serves to add a new Quest to a existing Chanters Board, at any chosen time into the Game.
|-
| 8. ...
| ...
|}

== Adding a placeable into an existing Area ==

'''M2DA Setup:'''

#AreaListName must not be "any". Chose a specific one.
#Copy the GDA into your modules override folder.

'''Script:''' (As taken from the Storage Chest mod a kind Bioware employee made :o)

<dascript>
//const string TAL_STORAGE_CHEST_SPAWNED = "TAL_STORAGE_CHEST_SPAWNED";
const string TAL_IP_STORAGE_CHEST = "tal_ip_storage_chest";
const resource TAL_RESOURCE_IP_STORAGE_CHEST = R"tal_ip_storage_chest.utp";

void main()
{
object oMainControlled = GetMainControlled();
object oChest = UT_GetNearestObjectByTag(oMainControlled, TAL_IP_STORAGE_CHEST);

//DisplayFloatyMessage(oMainControlled, "storage script working", FLOATY_MESSAGE, 16777215, 30.0);

if (!IsObjectValid(oChest))
{
location lSpawn = Location(GetArea(oMainControlled), Vector(148.77, 117.68, -0.94), 0.0);
CreateObject(OBJECT_TYPE_PLACEABLE, TAL_RESOURCE_IP_STORAGE_CHEST, lSpawn);

//DisplayFloatyMessage(oMainControlled, "storage chest created", FLOATY_MESSAGE, 16777215, 30.0);
}
}
</dascript>

#Replace "tal_ip_storage_chest" in the 2nd line with the "Tag" of your own placeable. (only small letters allowed)
#Replace "tal_ip_storage_chest.utp" in 3rd line with the Resources Filename of your placable.
#Exchange the (4) numbers after it sais "Vector" ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the placeable until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the placeable ,and start the game. When you arrive at the specific Area in game, the Placeable will be there.

'''Note:''' This method prevents removal of the placable. Check out a Plot driven method.

== Adding a NPC into an existing Area ==

'''M2DA Setup:'''

#AreaListName must be "any". This Script is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
// this is the name of a precreated plot file "joblos_quest" prefixed with the special "plt_"
// "plt_" + quest name allows you to reference the flag names as constants.
#include "plt_joblos_quest"
#include "wrappers_h"

void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag(PLT_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
); //this semicolom was missing and caused errors

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

#Replace "joblos_quest" (3x) with the name of your Plot.
#Replace "JOBLO_ADDED_TO_TOWN" (2x) with a custom Flag you create in your Plot.
#Replace "lot100ar_lothering" with the Tag of an Area ,the NPC should spawn in.
#Replace "joblo.utc" with the filename of your [[Creature]].
#Exchange the (4) numbers ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the NPC until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the creature ,and start the game. When you arrive at the specific Area in game, the [[Creature]] (Monsters or NPCs alike) will be there.

== Activating a Waypoint on the Worldmap ==

'''Requirements:''' Your module must extend Single Player.

'''M2DA Setup:'''

#AreaListName must be "any". Because Waypoint activation should be universal and it is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
const string WML_WOW_Custom = "eshmeswp";
#include "plt_mnp000pt_main_events"
#include "wrappers_h"
void main()
{
if(WR_GetPlotFlag( PLT_MNP000PT_MAIN_EVENTS, ARCHDEMON_EVENT_ONE) == TRUE )
{
WR_SetWorldMapLocationStatus(GetObjectByTag(WML_WOW_Custom), WM_LOCATION_ACTIVE);
}
}
</dascript>

#Replace "eshmeswp" in the 1st line with the "Tag" of your Waypoint (Map Pin) which u created. That Map Pin can be greyed out or inactive or so. Map Pin information can be found at: [[Map]].

Export the script, the Map ,and start the game. The Waypoint will now be activated once you leave Lothering, just like the other main Waypoints. This is to get in line with the Story. However to change the time of it happening..

#Choose which [[Plot]] should activate the Waypoint. The above example uses the Archdemon quest, when your nightmare triggers for example.
#Exchange "mnp000pt_main_events" in the 2nd and 6th line with the name of that other [[Plot]]. Leaving the "plt_" there.
#Exchange "ARCHDEMON_EVENT_ONE" with a "Flag" of your choice from that Plot.

This "should" work for any plot. Actually, waypoints dont need all this PRCSCR stuff and can be set "Active" in the first place. But the above example is to get in line with the Main Campaign, and potential gamebreaking Plot conflicts if able to leave Lothering too early.

== Adding an Item into the Players Inventory ==

'''Requirements:'''

'''M2DA Setup:'''
#AreaListName is "any".
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
//include utility_h for the UT_AddItemToInventory() function.
#include "utility_h"
//include the custom made plot file
#include "plt_$plot_file_name$"

void main()
{
// If plot flag is TRUE then item already given.
// Otherwise add item to inventory.
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == FALSE )
{
UT_AddItemToInventory(R"$item_file_name$.uti");
//Set the plot flag to TRUE to indicate that the item was given.
WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>
# Replace everything between and including the $ signs with appropriate names (without the file extensions).

== Adding an Item to an existing Vendor ==

'''Requirements:'''

'''M2DA Setup:'''

#Origins (Bodahn) - AreaListName should be "cam100ar_camp_plains".
#Awakening (Yuriah) - AreaListName should be "vgk210ar_throne_room".
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
#include "utility_h"
#include "plt_$plot_file_name$" // include your custom plot

void main()
{
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == TRUE ) return;

object oStore = GetObjectByTag("store_camp_bodahn"); // use this one for Bodahn/Origins
object oStore = GetObjectByTag("store_vgk100cr_merchant"); // use this one for Yuriah/Awakening

if (IsObjectValid(oStore))
{
CreateItemOnObject(R"$resource_name$.uti", oStore, 1, "", TRUE); // repeat this for each item

WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>

#Replace "$plot_file_name$" and "$check_flag_name$" with the custom [[Plot#Scripting|plot and plot flags]] you create for your module.
#Replace "$resource_name$" with the resource name of your custom item.
#The very first time you go to the party camp in Origins (after leaving Lothering) and view the Archdemon cutscene, this script will NOT run. This is because the cutscene version of the camp is actually a different area. In this case you must exit and return to the "normal" (non-cutscene) party camp for the script to run for the first time.

== Adding a Working Door into an existing Area ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

== Adding a Quest to an existing Chanters Board ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

[[category:tutorials]]
[[Category:Scripts]]
[[Category:Pages with example scripts]]

PRCSCR Script Templates

2010-05-27T15:45:25Z

Nezroy: /* Adding an Item to an existing Vendor */ fixing plot flags link

This page serves as a repository for ready to use M2DA's and Scripts to use in conjunction with [[PRCSCR]] M2DA's when adding custom content to the game.

References:
*See Main Article: ''[[PRCSCR]]''
*See ''[[PRCSCR.xls]]'' for details about that M2DA, or ''[[2DA]]'' for an explanation of 2DA's as a whole
*To create a Script, right click in the Resourcepalette and select "New/Script" , or see ''[[Designer Resources]]'' for such Resources as a whole.


__NOTOC__
'''Contents:'''
{| style="background-color:#eeeeee; border:2px #999999 solid; padding:4px; margin:4px" border="3"
| width=300 |[[PRCSCR Script Templates#Adding a placeable into an existing Area|1. Adding a placeable into an existing Area]]
| width=800 |This Script serves to add a placeable of your choice into an Area of choice. ''(non removable)''
|-
| [[PRCSCR Script Templates#Adding a NPC into an existing Area|2. Adding a NPC into an existing Area]]
| This Script serves to any custom NPC or Creature to a Area of choice. ''(removable)''
|-
| [[PRCSCR Script Templates#Activating a Waypoint on the Worldmap|3. Activating a Waypoint on the Worldmap]]
| This Script serves to activate a custom Waypoint (Map Pin) of choice ,when leaving Lothering or at any other time into the Game.
|-
| [[PRCSCR Script Templates#Adding an Item into the Players Inventory|4. Adding an Item into the Players Inventory]]
| This Script serves to instantly add an Item into the Players Inventory.
|-
| [[PRCSCR Script Templates#Adding an Item to an existing Vendor|5. Adding an Item to an existing Vendor]]
| This Script serves to add any Item into a existing Vendors Inventory, as long the Vendor exists.
|-
| 6. Adding a Working Door into an existing Area
| This Script serves to add a custom Door into a existing Area, that the Player can enter into a custom Area.
|-
| 7. Adding a Quest to an existing Chanters Board
| This Script serves to add a new Quest to a existing Chanters Board, at any chosen time into the Game.
|-
| 8. ...
| ...
|}

== Adding a placeable into an existing Area ==

'''M2DA Setup:'''

#AreaListName must not be "any". Chose a specific one.
#Copy the GDA into your modules override folder.

'''Script:''' (As taken from the Storage Chest mod a kind Bioware employee made :o)

<dascript>
//const string TAL_STORAGE_CHEST_SPAWNED = "TAL_STORAGE_CHEST_SPAWNED";
const string TAL_IP_STORAGE_CHEST = "tal_ip_storage_chest";
const resource TAL_RESOURCE_IP_STORAGE_CHEST = R"tal_ip_storage_chest.utp";

void main()
{
object oMainControlled = GetMainControlled();
object oChest = UT_GetNearestObjectByTag(oMainControlled, TAL_IP_STORAGE_CHEST);

//DisplayFloatyMessage(oMainControlled, "storage script working", FLOATY_MESSAGE, 16777215, 30.0);

if (!IsObjectValid(oChest))
{
location lSpawn = Location(GetArea(oMainControlled), Vector(148.77, 117.68, -0.94), 0.0);
CreateObject(OBJECT_TYPE_PLACEABLE, TAL_RESOURCE_IP_STORAGE_CHEST, lSpawn);

//DisplayFloatyMessage(oMainControlled, "storage chest created", FLOATY_MESSAGE, 16777215, 30.0);
}
}
</dascript>

#Replace "tal_ip_storage_chest" in the 2nd line with the "Tag" of your own placeable. (only small letters allowed)
#Replace "tal_ip_storage_chest.utp" in 3rd line with the Resources Filename of your placable.
#Exchange the (4) numbers after it sais "Vector" ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the placeable until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the placeable ,and start the game. When you arrive at the specific Area in game, the Placeable will be there.

'''Note:''' This method prevents removal of the placable. Check out a Plot driven method.

== Adding a NPC into an existing Area ==

'''M2DA Setup:'''

#AreaListName must be "any". This Script is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
// this is the name of a precreated plot file "joblos_quest" prefixed with the special "plt_"
// "plt_" + quest name allows you to reference the flag names as constants.
#include "plt_joblos_quest"
#include "wrappers_h"

void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag(PLT_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
); //this semicolom was missing and caused errors

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

#Replace "joblos_quest" (3x) with the name of your Plot.
#Replace "JOBLO_ADDED_TO_TOWN" (2x) with a custom Flag you create in your Plot.
#Replace "lot100ar_lothering" with the Tag of an Area ,the NPC should spawn in.
#Replace "joblo.utc" with the filename of your [[Creature]].
#Exchange the (4) numbers ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the NPC until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the creature ,and start the game. When you arrive at the specific Area in game, the [[Creature]] (Monsters or NPCs alike) will be there.

== Activating a Waypoint on the Worldmap ==

'''Requirements:''' Your module must extend Single Player.

'''M2DA Setup:'''

#AreaListName must be "any". Because Waypoint activation should be universal and it is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
const string WML_WOW_Custom = "eshmeswp";
#include "plt_mnp000pt_main_events"
#include "wrappers_h"
void main()
{
if(WR_GetPlotFlag( PLT_MNP000PT_MAIN_EVENTS, ARCHDEMON_EVENT_ONE) == TRUE )
{
WR_SetWorldMapLocationStatus(GetObjectByTag(WML_WOW_Custom), WM_LOCATION_ACTIVE);
}
}
</dascript>

#Replace "eshmeswp" in the 1st line with the "Tag" of your Waypoint (Map Pin) which u created. That Map Pin can be greyed out or inactive or so. Map Pin information can be found at: [[Map]].

Export the script, the Map ,and start the game. The Waypoint will now be activated once you leave Lothering, just like the other main Waypoints. This is to get in line with the Story. However to change the time of it happening..

#Choose which [[Plot]] should activate the Waypoint. The above example uses the Archdemon quest, when your nightmare triggers for example.
#Exchange "mnp000pt_main_events" in the 2nd and 6th line with the name of that other [[Plot]]. Leaving the "plt_" there.
#Exchange "ARCHDEMON_EVENT_ONE" with a "Flag" of your choice from that Plot.

This "should" work for any plot. Actually, waypoints dont need all this PRCSCR stuff and can be set "Active" in the first place. But the above example is to get in line with the Main Campaign, and potential gamebreaking Plot conflicts if able to leave Lothering too early.

== Adding an Item into the Players Inventory ==

'''Requirements:'''

'''M2DA Setup:'''
#AreaListName is "any".
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
//include utility_h for the UT_AddItemToInventory() function.
#include "utility_h"
//include the custom made plot file
#include "plt_$plot_file_name$"

void main()
{
// If plot flag is TRUE then item already given.
// Otherwise add item to inventory.
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == FALSE )
{
UT_AddItemToInventory(R"$item_file_name$.uti");
//Set the plot flag to TRUE to indicate that the item was given.
WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>
# Replace everything between and including the $ signs with appropriate names (without the file extensions).

== Adding an Item to an existing Vendor ==

'''Requirements:'''

'''M2DA Setup:'''

#Origins (Bodahn) - AreaListName should be "cam100ar_camp_plains".
#Awakening (Yuriah) - AreaListName should be "vgk210ar_throne_room".
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
#include "utility_h"
#include "plt_$plot_file_name$" // include your custom plot

void main()
{
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == TRUE ) return;

object oStore = GetObjectByTag("store_camp_bodahn"); // use this one for Bodahn/Origins
object oStore = GetObjectByTag("store_vgk100cr_merchant"); // use this one for Yuriah/Awakening

if (IsObjectValid(oStore))
{
CreateItemOnObject(R"$resource_name$.uti", oStore, 1, "", TRUE); // repeat this for each item

WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>

#Replace "$plot_file_name$" and "$check_flag_name$" with the custom [[Plot#Plot_event_scripts|plot and plot flags]] you create for your module.
#Replace "$resource_name$" with the resource name of your custom item.
#The very first time you go to the party camp in Origins (after leaving Lothering) and view the Archdemon cutscene, this script will NOT run. This is because the cutscene version of the camp is actually a different area. In this case you must exit and return to the "normal" (non-cutscene) party camp for the script to run for the first time.

== Adding a Working Door into an existing Area ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

== Adding a Quest to an existing Chanters Board ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

[[category:tutorials]]
[[Category:Scripts]]
[[Category:Pages with example scripts]]

PRCSCR Script Templates

2010-05-27T15:43:13Z

Nezroy: toc to new script

This page serves as a repository for ready to use M2DA's and Scripts to use in conjunction with [[PRCSCR]] M2DA's when adding custom content to the game.

References:
*See Main Article: ''[[PRCSCR]]''
*See ''[[PRCSCR.xls]]'' for details about that M2DA, or ''[[2DA]]'' for an explanation of 2DA's as a whole
*To create a Script, right click in the Resourcepalette and select "New/Script" , or see ''[[Designer Resources]]'' for such Resources as a whole.


__NOTOC__
'''Contents:'''
{| style="background-color:#eeeeee; border:2px #999999 solid; padding:4px; margin:4px" border="3"
| width=300 |[[PRCSCR Script Templates#Adding a placeable into an existing Area|1. Adding a placeable into an existing Area]]
| width=800 |This Script serves to add a placeable of your choice into an Area of choice. ''(non removable)''
|-
| [[PRCSCR Script Templates#Adding a NPC into an existing Area|2. Adding a NPC into an existing Area]]
| This Script serves to any custom NPC or Creature to a Area of choice. ''(removable)''
|-
| [[PRCSCR Script Templates#Activating a Waypoint on the Worldmap|3. Activating a Waypoint on the Worldmap]]
| This Script serves to activate a custom Waypoint (Map Pin) of choice ,when leaving Lothering or at any other time into the Game.
|-
| [[PRCSCR Script Templates#Adding an Item into the Players Inventory|4. Adding an Item into the Players Inventory]]
| This Script serves to instantly add an Item into the Players Inventory.
|-
| [[PRCSCR Script Templates#Adding an Item to an existing Vendor|5. Adding an Item to an existing Vendor]]
| This Script serves to add any Item into a existing Vendors Inventory, as long the Vendor exists.
|-
| 6. Adding a Working Door into an existing Area
| This Script serves to add a custom Door into a existing Area, that the Player can enter into a custom Area.
|-
| 7. Adding a Quest to an existing Chanters Board
| This Script serves to add a new Quest to a existing Chanters Board, at any chosen time into the Game.
|-
| 8. ...
| ...
|}

== Adding a placeable into an existing Area ==

'''M2DA Setup:'''

#AreaListName must not be "any". Chose a specific one.
#Copy the GDA into your modules override folder.

'''Script:''' (As taken from the Storage Chest mod a kind Bioware employee made :o)

<dascript>
//const string TAL_STORAGE_CHEST_SPAWNED = "TAL_STORAGE_CHEST_SPAWNED";
const string TAL_IP_STORAGE_CHEST = "tal_ip_storage_chest";
const resource TAL_RESOURCE_IP_STORAGE_CHEST = R"tal_ip_storage_chest.utp";

void main()
{
object oMainControlled = GetMainControlled();
object oChest = UT_GetNearestObjectByTag(oMainControlled, TAL_IP_STORAGE_CHEST);

//DisplayFloatyMessage(oMainControlled, "storage script working", FLOATY_MESSAGE, 16777215, 30.0);

if (!IsObjectValid(oChest))
{
location lSpawn = Location(GetArea(oMainControlled), Vector(148.77, 117.68, -0.94), 0.0);
CreateObject(OBJECT_TYPE_PLACEABLE, TAL_RESOURCE_IP_STORAGE_CHEST, lSpawn);

//DisplayFloatyMessage(oMainControlled, "storage chest created", FLOATY_MESSAGE, 16777215, 30.0);
}
}
</dascript>

#Replace "tal_ip_storage_chest" in the 2nd line with the "Tag" of your own placeable. (only small letters allowed)
#Replace "tal_ip_storage_chest.utp" in 3rd line with the Resources Filename of your placable.
#Exchange the (4) numbers after it sais "Vector" ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the placeable until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the placeable ,and start the game. When you arrive at the specific Area in game, the Placeable will be there.

'''Note:''' This method prevents removal of the placable. Check out a Plot driven method.

== Adding a NPC into an existing Area ==

'''M2DA Setup:'''

#AreaListName must be "any". This Script is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
// this is the name of a precreated plot file "joblos_quest" prefixed with the special "plt_"
// "plt_" + quest name allows you to reference the flag names as constants.
#include "plt_joblos_quest"
#include "wrappers_h"

void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag(PLT_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
); //this semicolom was missing and caused errors

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

#Replace "joblos_quest" (3x) with the name of your Plot.
#Replace "JOBLO_ADDED_TO_TOWN" (2x) with a custom Flag you create in your Plot.
#Replace "lot100ar_lothering" with the Tag of an Area ,the NPC should spawn in.
#Replace "joblo.utc" with the filename of your [[Creature]].
#Exchange the (4) numbers ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the NPC until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the creature ,and start the game. When you arrive at the specific Area in game, the [[Creature]] (Monsters or NPCs alike) will be there.

== Activating a Waypoint on the Worldmap ==

'''Requirements:''' Your module must extend Single Player.

'''M2DA Setup:'''

#AreaListName must be "any". Because Waypoint activation should be universal and it is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
const string WML_WOW_Custom = "eshmeswp";
#include "plt_mnp000pt_main_events"
#include "wrappers_h"
void main()
{
if(WR_GetPlotFlag( PLT_MNP000PT_MAIN_EVENTS, ARCHDEMON_EVENT_ONE) == TRUE )
{
WR_SetWorldMapLocationStatus(GetObjectByTag(WML_WOW_Custom), WM_LOCATION_ACTIVE);
}
}
</dascript>

#Replace "eshmeswp" in the 1st line with the "Tag" of your Waypoint (Map Pin) which u created. That Map Pin can be greyed out or inactive or so. Map Pin information can be found at: [[Map]].

Export the script, the Map ,and start the game. The Waypoint will now be activated once you leave Lothering, just like the other main Waypoints. This is to get in line with the Story. However to change the time of it happening..

#Choose which [[Plot]] should activate the Waypoint. The above example uses the Archdemon quest, when your nightmare triggers for example.
#Exchange "mnp000pt_main_events" in the 2nd and 6th line with the name of that other [[Plot]]. Leaving the "plt_" there.
#Exchange "ARCHDEMON_EVENT_ONE" with a "Flag" of your choice from that Plot.

This "should" work for any plot. Actually, waypoints dont need all this PRCSCR stuff and can be set "Active" in the first place. But the above example is to get in line with the Main Campaign, and potential gamebreaking Plot conflicts if able to leave Lothering too early.

== Adding an Item into the Players Inventory ==

'''Requirements:'''

'''M2DA Setup:'''
#AreaListName is "any".
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
//include utility_h for the UT_AddItemToInventory() function.
#include "utility_h"
//include the custom made plot file
#include "plt_$plot_file_name$"

void main()
{
// If plot flag is TRUE then item already given.
// Otherwise add item to inventory.
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == FALSE )
{
UT_AddItemToInventory(R"$item_file_name$.uti");
//Set the plot flag to TRUE to indicate that the item was given.
WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>
# Replace everything between and including the $ signs with appropriate names (without the file extensions).

== Adding an Item to an existing Vendor ==

'''Requirements:'''

'''M2DA Setup:'''

#Origins (Bodahn) - AreaListName should be "cam100ar_camp_plains".
#Awakening (Yuriah) - AreaListName should be "vgk210ar_throne_room".
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
#include "utility_h"
#include "plt_$plot_file_name$" // include your custom plot

void main()
{
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == TRUE ) return;

object oStore = GetObjectByTag("store_camp_bodahn"); // use this one for Bodahn/Origins
object oStore = GetObjectByTag("store_vgk100cr_merchant"); // use this one for Yuriah/Awakening

if (IsObjectValid(oStore))
{
CreateItemOnObject(R"$resource_name$.uti", oStore, 1, "", TRUE); // repeat this for each item

WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>

#Replace "$plot_file_name$" and "$check_flag_name$" with the custom [Plot#Plot_event_scripts plot and plot flags] you create for your module.
#Replace "$resource_name$" with the resource name of your custom item.
#The very first time you go to the party camp in Origins (after leaving Lothering) and view the Archdemon cutscene, this script will NOT run. This is because the cutscene version of the camp is actually a different area. In this case you must exit and return to the "normal" (non-cutscene) party camp for the script to run for the first time.

== Adding a Working Door into an existing Area ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

== Adding a Quest to an existing Chanters Board ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

[[category:tutorials]]
[[Category:Scripts]]
[[Category:Pages with example scripts]]

PRCSCR Script Templates

2010-05-27T15:42:20Z

Nezroy: /* Adding an Item to an existing Vendor */

This page serves as a repository for ready to use M2DA's and Scripts to use in conjunction with [[PRCSCR]] M2DA's when adding custom content to the game.

References:
*See Main Article: ''[[PRCSCR]]''
*See ''[[PRCSCR.xls]]'' for details about that M2DA, or ''[[2DA]]'' for an explanation of 2DA's as a whole
*To create a Script, right click in the Resourcepalette and select "New/Script" , or see ''[[Designer Resources]]'' for such Resources as a whole.


__NOTOC__
'''Contents:'''
{| style="background-color:#eeeeee; border:2px #999999 solid; padding:4px; margin:4px" border="3"
| width=300 |[[PRCSCR Script Templates#Adding a placeable into an existing Area|1. Adding a placeable into an existing Area]]
| width=800 |This Script serves to add a placeable of your choice into an Area of choice. ''(non removable)''
|-
| [[PRCSCR Script Templates#Adding a NPC into an existing Area|2. Adding a NPC into an existing Area]]
| This Script serves to any custom NPC or Creature to a Area of choice. ''(removable)''
|-
| [[PRCSCR Script Templates#Activating a Waypoint on the Worldmap|3. Activating a Waypoint on the Worldmap]]
| This Script serves to activate a custom Waypoint (Map Pin) of choice ,when leaving Lothering or at any other time into the Game.
|-
| [[PRCSCR Script Templates#Adding an Item into the Players Inventory|4. Adding an Item into the Players Inventory]]
| This Script serves to instantly add an Item into the Players Inventory.
|-
| 5. Adding an Item to an existing Vendor
| This Script serves to add any Item into a existing Vendors Inventory, as long the Vendor exists.
|-
| 6. Adding a Working Door into an existing Area
| This Script serves to add a custom Door into a existing Area, that the Player can enter into a custom Area.
|-
| 7. Adding a Quest to an existing Chanters Board
| This Script serves to add a new Quest to a existing Chanters Board, at any chosen time into the Game.
|-
| 8. ...
| ...
|}

== Adding a placeable into an existing Area ==

'''M2DA Setup:'''

#AreaListName must not be "any". Chose a specific one.
#Copy the GDA into your modules override folder.

'''Script:''' (As taken from the Storage Chest mod a kind Bioware employee made :o)

<dascript>
//const string TAL_STORAGE_CHEST_SPAWNED = "TAL_STORAGE_CHEST_SPAWNED";
const string TAL_IP_STORAGE_CHEST = "tal_ip_storage_chest";
const resource TAL_RESOURCE_IP_STORAGE_CHEST = R"tal_ip_storage_chest.utp";

void main()
{
object oMainControlled = GetMainControlled();
object oChest = UT_GetNearestObjectByTag(oMainControlled, TAL_IP_STORAGE_CHEST);

//DisplayFloatyMessage(oMainControlled, "storage script working", FLOATY_MESSAGE, 16777215, 30.0);

if (!IsObjectValid(oChest))
{
location lSpawn = Location(GetArea(oMainControlled), Vector(148.77, 117.68, -0.94), 0.0);
CreateObject(OBJECT_TYPE_PLACEABLE, TAL_RESOURCE_IP_STORAGE_CHEST, lSpawn);

//DisplayFloatyMessage(oMainControlled, "storage chest created", FLOATY_MESSAGE, 16777215, 30.0);
}
}
</dascript>

#Replace "tal_ip_storage_chest" in the 2nd line with the "Tag" of your own placeable. (only small letters allowed)
#Replace "tal_ip_storage_chest.utp" in 3rd line with the Resources Filename of your placable.
#Exchange the (4) numbers after it sais "Vector" ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the placeable until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the placeable ,and start the game. When you arrive at the specific Area in game, the Placeable will be there.

'''Note:''' This method prevents removal of the placable. Check out a Plot driven method.

== Adding a NPC into an existing Area ==

'''M2DA Setup:'''

#AreaListName must be "any". This Script is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
// this is the name of a precreated plot file "joblos_quest" prefixed with the special "plt_"
// "plt_" + quest name allows you to reference the flag names as constants.
#include "plt_joblos_quest"
#include "wrappers_h"

void main()
{
//Check whether we've added Joblo already.
if (WR_GetPlotFlag(PLT_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
); //this semicolom was missing and caused errors

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

#Replace "joblos_quest" (3x) with the name of your Plot.
#Replace "JOBLO_ADDED_TO_TOWN" (2x) with a custom Flag you create in your Plot.
#Replace "lot100ar_lothering" with the Tag of an Area ,the NPC should spawn in.
#Replace "joblo.utc" with the filename of your [[Creature]].
#Exchange the (4) numbers ,which should be the location of your placable. How to determine?
#Create a temporary duplicate of the specific Area, and add the NPC until you see fit. (delete this Area afterwards, do not export)
#Note down the numbers in the Object Inspector, and get the first 3 numbers of Position, and the 4rth Number from Rotation. (only 1 number, the first)
#Rotation needs to be recalculated before entering it into the script. For positive angles do (180-angle). For negative angles do (-180-(-angle)).

Export the script, the creature ,and start the game. When you arrive at the specific Area in game, the [[Creature]] (Monsters or NPCs alike) will be there.

== Activating a Waypoint on the Worldmap ==

'''Requirements:''' Your module must extend Single Player.

'''M2DA Setup:'''

#AreaListName must be "any". Because Waypoint activation should be universal and it is Plot driven.
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
const string WML_WOW_Custom = "eshmeswp";
#include "plt_mnp000pt_main_events"
#include "wrappers_h"
void main()
{
if(WR_GetPlotFlag( PLT_MNP000PT_MAIN_EVENTS, ARCHDEMON_EVENT_ONE) == TRUE )
{
WR_SetWorldMapLocationStatus(GetObjectByTag(WML_WOW_Custom), WM_LOCATION_ACTIVE);
}
}
</dascript>

#Replace "eshmeswp" in the 1st line with the "Tag" of your Waypoint (Map Pin) which u created. That Map Pin can be greyed out or inactive or so. Map Pin information can be found at: [[Map]].

Export the script, the Map ,and start the game. The Waypoint will now be activated once you leave Lothering, just like the other main Waypoints. This is to get in line with the Story. However to change the time of it happening..

#Choose which [[Plot]] should activate the Waypoint. The above example uses the Archdemon quest, when your nightmare triggers for example.
#Exchange "mnp000pt_main_events" in the 2nd and 6th line with the name of that other [[Plot]]. Leaving the "plt_" there.
#Exchange "ARCHDEMON_EVENT_ONE" with a "Flag" of your choice from that Plot.

This "should" work for any plot. Actually, waypoints dont need all this PRCSCR stuff and can be set "Active" in the first place. But the above example is to get in line with the Main Campaign, and potential gamebreaking Plot conflicts if able to leave Lothering too early.

== Adding an Item into the Players Inventory ==

'''Requirements:'''

'''M2DA Setup:'''
#AreaListName is "any".
#Copy the GDA into your modules override folder.

'''Script:'''
<dascript>
//include utility_h for the UT_AddItemToInventory() function.
#include "utility_h"
//include the custom made plot file
#include "plt_$plot_file_name$"

void main()
{
// If plot flag is TRUE then item already given.
// Otherwise add item to inventory.
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == FALSE )
{
UT_AddItemToInventory(R"$item_file_name$.uti");
//Set the plot flag to TRUE to indicate that the item was given.
WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>
# Replace everything between and including the $ signs with appropriate names (without the file extensions).

== Adding an Item to an existing Vendor ==

'''Requirements:'''

'''M2DA Setup:'''

#Origins (Bodahn) - AreaListName should be "cam100ar_camp_plains".
#Awakening (Yuriah) - AreaListName should be "vgk210ar_throne_room".
#Copy the GDA into your modules override folder.

'''Script:'''

<dascript>
#include "utility_h"
#include "plt_$plot_file_name$" // include your custom plot

void main()
{
if ( WR_GetPlotFlag( PLT_$plot_file_name$, $check_flag_name$ ) == TRUE ) return;

object oStore = GetObjectByTag("store_camp_bodahn"); // use this one for Bodahn/Origins
object oStore = GetObjectByTag("store_vgk100cr_merchant"); // use this one for Yuriah/Awakening

if (IsObjectValid(oStore))
{
CreateItemOnObject(R"$resource_name$.uti", oStore, 1, "", TRUE); // repeat this for each item

WR_SetPlotFlag( PLT_$plot_file_name$, $check_flag_name$, TRUE );
}
}
</dascript>

#Replace "$plot_file_name$" and "$check_flag_name$" with the custom [Plot#Plot_event_scripts plot and plot flags] you create for your module.
#Replace "$resource_name$" with the resource name of your custom item.
#The very first time you go to the party camp in Origins (after leaving Lothering) and view the Archdemon cutscene, this script will NOT run. This is because the cutscene version of the camp is actually a different area. In this case you must exit and return to the "normal" (non-cutscene) party camp for the script to run for the first time.

== Adding a Working Door into an existing Area ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

== Adding a Quest to an existing Chanters Board ==

'''Requirements:'''

'''M2DA Setup:'''

'''Script:''' {{undocumented}}

[[category:tutorials]]
[[Category:Scripts]]
[[Category:Pages with example scripts]]

Console

2010-05-27T15:17:28Z

Nezroy: adding link to make console commands visible mod

Up in the View Menu other windows you will see one called "Console".

This is where you would enter console commands that allow the toolset to interact with the game engine. It is mostly (if not always) used when you have an area open in the Area Editor.

The console commands were built to work with the game not the toolset but some of them do work with the toolset alone.

Your toolset will crash when using some of them so make sure you save your work before trying them.

== Using the console in-game ==

The in-game console is normally not accessible. To enable it run the game with a command line parameter "-enabledeveloperconsole". Then, when the game is running, press the tilde key (~) to bring up the console. This is a prompt in the upper left corner of the screen. The console was used extensively in development for debugging and testing purposes, but in the finished version of the game there's only one console command available; "runscript".

The runscript command does exactly as it says - it runs a script, given as a name typed after a space. So for example:

<pre>
>runscript killallhostiles
</pre>

will cause the script named "killallhostiles" to be run.

You can pass the script additional parameters if you like. These parameters will be stored in the [[module]] variable RUNSCRIPT_VAR. RUNSCRIPT_VAR is a simple string, your script will need to parse it itself.

'''Caution:''' Using scripts like killallhostiles may break scripted plot situations, so you should avoid using it outside of custom content testing.

For example,

<pre>
>runscript usespecificobject demo100pl_lever
</pre>

calls the script "usespecificobject" and puts "demo100pl_lever" into the module RUNSCRIPT_VAR. The script can then call

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

to retrieve it.

If you need more than one parameter, pick a separator (a space is usually most appropriate) and split up the string in RUNSCRIPT_VAR appropriately. For example:

<dascript>
//parse out first parameter - the object to use.
nSpaceLoc = FindSubString(sParam," ");
sTemp = SubString(sParam,0,nSpaceLoc);
oDestination = GetObjectByTag(sTemp);
</dascript>

== Console text is invisible in some game installs ==

This problem is caused in some systems by the DVD's installer failing to install the fonts.erf file. Fonts.erf is included on the game disk, so you should be able to redo this part of the installation and properly install fonts.erf by running datasetup.exe manually (which is on the game disk in the "data" directory). This should not be an issue for Steam users since a different installer is involved in Steam installations.

If you still have trouble obtaining fonts.erf from your installation, install the [http://social.bioware.com/page/da-character-creator Character Creator] and then copy fonts.erf from ''Dragon Age Origins Character Creator\packages\core\data''.

Alternatively, install the free 7-zip program, right click on ''data\DataSetup.exe'', select ''7-Zip -> Open archive'', and then extract fonts.erf from ''$0"\packages\core\data\"''.

You can also get the font from the [http://dragonagenexus.com/downloads/file.php?id=1110 Make CONSOLE commands visible] mod.

Ranged Weapons and Ammunition

2010-04-09T22:06:51Z

Nezroy: /* Item and Ammunition Variations and Models */

This article explains the relationship between ranged weapons and their ammunition types, how default ammo works, and how the weapon and ammunition (quiver) models and variants interrelate. This discussion applies to all four standard ranged weapons in Dragon Age: longbows, shortbows, crossbows, and staffs; and to their associated ammo types: arrows, bolts, and staff projectiles.

== Defining and Linking Weapons and Ammunition ==

Weapon types are defined in the [[BITM_base.xls]] 2da. There are two fields of importance for ranged weapons:

* Type - This is a value from the _ItemTypes worksheet; bows use [[ITEM_TYPE_WEAPON_RANGED]] and staffs use [[ITEM_TYPE_WEAPON_MAGIC]]. (I think this determines the base hit model; ranged weapon types can miss but can also crit, while magic weapon types cannot miss but also cannot crit).
* Ammo - This is a reference to the ID in [[BITM_base.xls]] of the ammunition type that the weapon uses. For instance, longbows and shortbows use the arrow ammo type, crossbows use the bolt ammo type, and staffs use the staff projectile ammo type.

Ammo types are also defined in the [[BITM_base.xls]] 2da. There are three fields of note for ammunition:

* Type - This is a value from the _ItemTypes worksheet; ammo uses [[ITEM_TYPE_AMMO]].
* DefaultResource - This is a string that matches the tag of the default ammunition item to use when no ammunition is equipped. The default arrow type is "gen_im_arrow", the default bolt is "gen_im_bolt", and the default staff projectile is "gen_im_staff_projectile". These default ammo items can all be found in the _Global/HOLDING item folder in the toolset.
* Projectile - This is the ID of an entry in the [[PRJ_base.xls]] 2da, which defines the projectile model/animation to use for the ammo as well as base modifiers to damage. The value defined here can be changed for a specific item by setting the PROJECTILE_OVERRIDE variable on that item's UTI definition to a different projectile ID. This variable should be set on the weapon that uses the ammo, not the ammo item itself.

When a ranged or magic weapon is equipped, the player's ammunition slot is automatically populated with an instance of the ammo's default resource. This item cannot be unequipped and is never consumed, which is how the infinite default arrow/bolt/staff projectiles work.

== Item and Ammunition Variations and Models ==

The model that is displayed for ammunition is independent of the model displayed for the weapon itself. In the case of arrows and bolts, the quiver models are shown whenever arrows or bolts are equipped, even if no weapon is equipped. This can be verified by equipping special ammo types like Ice Arrows with no weapon equipped.

However, when equipping an ammo using weapon, like a bow, the infinite default resource ammunition item is automatically created/equipped as well, so the quiver displays even when no specific arrows are equipped. The game is behaving as though a gen_im_arrow item is equipped, and displaying its model.

You can create new arrow and bolt variations using the [[ItemVariations.xls]] 2da, which are actually variants of the quiver model shown on the back. (TODO - I'm not sure how the location/attachment point of the quiver model is defined for arrows/bolts, and why it's not defined for staff projectiles, other than that arrows/bolts have item variation worksheets and staff projectiles don't). If you were then to create new arrow items in the toolset that use your custom quiver variant, your custom quiver would be shown when that ammo is equipped. (To actually change the arrow/bolt models shown in-flight, you would instead need to create a new projectile type in [[PRJ_base.xls]], then assign that projectile to your ammo or override the projectile for a specific weapon).

The longbow, shortbow, and crossbow item variation 2da's have an extra column called DefaultAmmoVariation that links to an ID in the arrow/bolt variant 2das. The default infinite ammo resource that is created when you equip that weapon will use the variant ID specified here. For example, if you had created a custom arrow variant (quiver), you could then create a custom bow variant that specifies your custom arrow variant ID in this field, and that is the quiver model that will be shown when the bow is equipped with the default infinite ammo.

Unfortunately the limitation is that non-default ammo items like Ice Arrows, Fire Arrows, etc., are actually separate ammo items and do not reflect the DefaultAmmoVariation specified in the weapon variant. These items instead have their variant defined based on their UTI definition, just like any other item. This means that when one of these ammo types is equipped, the custom quiver variant being displayed for the default ammo will disappear and the ammo item will display the generic quiver since that is the variant it uses.

There is no perfectly clean solution for handling this. You can override the item variant for all of the non-default ammo items, but that will cause your custom quiver variant to display when that ammo is equipped on any PC/NPC, regardless of the bow they are using.

Another option is to create duplicate versions of all the ammo items and change those duplicates to use your custom ammo variant. If you used these items instead of the normal ammo items, you would then see the custom quiver. Of course this has its own problems; you have to continually produce a supply of these duplicate items for yourself (since ammo is consumed), and will not be able to use "found" ammo items since they will still be of the original item type with the default variant. This option can be expanded by providing some mechanism for converting the standard types to your custom duplicate types; e.g. you could hook the [[EVENT_TYPE_EQUIP]] event and have a script that converts ammo from the vanilla version to your duplicate custom variant version when your custom weapon is also equipped.

[[Category:Projectiles]]
[[Category:Items]]
[[Category:Rules]]

Ranged Weapons and Ammunition

2010-04-09T22:05:46Z

Nezroy: /* Item and Ammunition Variations and Models */

This article explains the relationship between ranged weapons and their ammunition types, how default ammo works, and how the weapon and ammunition (quiver) models and variants interrelate. This discussion applies to all four standard ranged weapons in Dragon Age: longbows, shortbows, crossbows, and staffs; and to their associated ammo types: arrows, bolts, and staff projectiles.

== Defining and Linking Weapons and Ammunition ==

Weapon types are defined in the [[BITM_base.xls]] 2da. There are two fields of importance for ranged weapons:

* Type - This is a value from the _ItemTypes worksheet; bows use [[ITEM_TYPE_WEAPON_RANGED]] and staffs use [[ITEM_TYPE_WEAPON_MAGIC]]. (I think this determines the base hit model; ranged weapon types can miss but can also crit, while magic weapon types cannot miss but also cannot crit).
* Ammo - This is a reference to the ID in [[BITM_base.xls]] of the ammunition type that the weapon uses. For instance, longbows and shortbows use the arrow ammo type, crossbows use the bolt ammo type, and staffs use the staff projectile ammo type.

Ammo types are also defined in the [[BITM_base.xls]] 2da. There are three fields of note for ammunition:

* Type - This is a value from the _ItemTypes worksheet; ammo uses [[ITEM_TYPE_AMMO]].
* DefaultResource - This is a string that matches the tag of the default ammunition item to use when no ammunition is equipped. The default arrow type is "gen_im_arrow", the default bolt is "gen_im_bolt", and the default staff projectile is "gen_im_staff_projectile". These default ammo items can all be found in the _Global/HOLDING item folder in the toolset.
* Projectile - This is the ID of an entry in the [[PRJ_base.xls]] 2da, which defines the projectile model/animation to use for the ammo as well as base modifiers to damage. The value defined here can be changed for a specific item by setting the PROJECTILE_OVERRIDE variable on that item's UTI definition to a different projectile ID. This variable should be set on the weapon that uses the ammo, not the ammo item itself.

When a ranged or magic weapon is equipped, the player's ammunition slot is automatically populated with an instance of the ammo's default resource. This item cannot be unequipped and is never consumed, which is how the infinite default arrow/bolt/staff projectiles work.

== Item and Ammunition Variations and Models ==

The model that is displayed for ammunition is independent of the model displayed for the weapon itself. In the case of arrows and bolts, the quiver models are shown whenever arrows or bolts are equipped, even if no weapon is equipped. This can be verified by equipping special ammo types like Ice Arrows with no weapon equipped.

However, when equipping an ammo using weapon, like a bow, the infinite default resource ammunition item is automatically created/equipped as well, so the quiver displays even when no specific arrows are equipped. The game is behaving as though a gen_im_arrow item is equipped, and displaying its model.

You can create new arrow and bolt variations using the [[ItemVariations.xls]] 2da, which are actually variants of the quiver model shown on the back. (TODO - I'm not sure how the location/attachment point of the quiver model is defined for arrows/bolts, and why it's not defined for staff projectiles, other than that arrows/bolts have item variation worksheets and staff projectiles don't). If you were then to create new arrow items in the toolset that use your custom quiver variant, your custom quiver would be shown when that ammo is equipped. (To actually change the arrow/bolt models shown in-flight, you would instead need to create a new projectile type in [[PRJ_base.xls]], then assign that projectile to your ammo or override the projectile for a specific weapon).

The longbow, shortbow, and crossbow item variation 2da's have an extra column called DefaultAmmoVariation that links to an ID in the arrow/bolt variant 2das. The default infinite ammo resource that is created when you equip that weapon will use the variant ID specified here. For example, if you had created a custom arrow variant (quiver), you could then create a custom bow variant that specifies your custom arrow variant ID in this field, and that is the quiver model that will be shown when the bow is equipped with the default infinite ammo.

Unfortunately the limitation is that non-default ammo items like Ice Arrows, Fire Arrows, etc., are actually separate ammo items and do not reflect the DefaultAmmoVariation specified in the weapon variant. These items instead have their variant defined based on their UTI definition, just like any other item. This means that when one of these ammo types is equipped, the custom quiver variant being displayed for the default ammo will disappear and the ammo item will display the generic quiver since that is the variant it uses.

There is no perfectly clean solution for handling this. You can override the item variant for all of the non-default ammo items, but that will cause your custom quiver variant to display when that ammo is equipped on any PC/NPC, regardless of the bow they are using.

Another option is to create duplicate versions of all the ammo items and change those duplicates to use your custom ammo variant. If you used these items instead of the normal ammo items, you would then see the custom quiver. Of course this has its own problems; you have to continually produce a supply of these duplicate items for yourself (since ammo is consumed), and will not be able to use "found" ammo items since they will still be off the original item type with the default variant. This option can be expanded by providing some mechanism for converting the standard types to your custom duplicate types; e.g. you could hook the [[EVENT_TYPE_EQUIP]] event and have a script that converts ammo from the vanilla version to your duplicate custom variant version when your custom weapon is also equipped.

[[Category:Projectiles]]
[[Category:Items]]
[[Category:Rules]]

Ranged Weapons and Ammunition

2010-04-09T22:03:21Z

Nezroy: /* Defining and Linking Weapons and Ammunition */

This article explains the relationship between ranged weapons and their ammunition types, how default ammo works, and how the weapon and ammunition (quiver) models and variants interrelate. This discussion applies to all four standard ranged weapons in Dragon Age: longbows, shortbows, crossbows, and staffs; and to their associated ammo types: arrows, bolts, and staff projectiles.

== Defining and Linking Weapons and Ammunition ==

Weapon types are defined in the [[BITM_base.xls]] 2da. There are two fields of importance for ranged weapons:

* Type - This is a value from the _ItemTypes worksheet; bows use [[ITEM_TYPE_WEAPON_RANGED]] and staffs use [[ITEM_TYPE_WEAPON_MAGIC]]. (I think this determines the base hit model; ranged weapon types can miss but can also crit, while magic weapon types cannot miss but also cannot crit).
* Ammo - This is a reference to the ID in [[BITM_base.xls]] of the ammunition type that the weapon uses. For instance, longbows and shortbows use the arrow ammo type, crossbows use the bolt ammo type, and staffs use the staff projectile ammo type.

Ammo types are also defined in the [[BITM_base.xls]] 2da. There are three fields of note for ammunition:

* Type - This is a value from the _ItemTypes worksheet; ammo uses [[ITEM_TYPE_AMMO]].
* DefaultResource - This is a string that matches the tag of the default ammunition item to use when no ammunition is equipped. The default arrow type is "gen_im_arrow", the default bolt is "gen_im_bolt", and the default staff projectile is "gen_im_staff_projectile". These default ammo items can all be found in the _Global/HOLDING item folder in the toolset.
* Projectile - This is the ID of an entry in the [[PRJ_base.xls]] 2da, which defines the projectile model/animation to use for the ammo as well as base modifiers to damage. The value defined here can be changed for a specific item by setting the PROJECTILE_OVERRIDE variable on that item's UTI definition to a different projectile ID. This variable should be set on the weapon that uses the ammo, not the ammo item itself.

When a ranged or magic weapon is equipped, the player's ammunition slot is automatically populated with an instance of the ammo's default resource. This item cannot be unequipped and is never consumed, which is how the infinite default arrow/bolt/staff projectiles work.

== Item and Ammunition Variations and Models ==

The model that is displayed for ammunition is independent of the model displayed for the weapon itself. In the case of arrows and bolts, the quiver models are shown whenever arrows or bolts are equipped, even if no weapon is equipped. This can be verified by equipping special ammo types like Ice Arrows with no weapon equipped.

However, when equipping an ammo using weapon, like a bow, the infinite default resource ammunition item is automatically created/equipped as well, so the quiver displays even when no specific arrows are equipped. The game is behaving as though a gen_im_arrow item is equipped, and displaying its model.

You can create new arrow and bolt variations using the [[ItemVariations.xls]] 2da, which are actually variants of the quiver model shown on the back. (TODO - I'm not sure how the location/attachment point of the quiver model is defined for arrows/bolts, and why it's not defined for staff projectiles, other than that arrows/bolts have item variation worksheets and staff projectiles don't). If you were then to create new arrow items in the toolset that use your custom quiver variant, your custom quiver would be shown when that ammo is equipped. (To actually change the arrow/bolt models shown in-flight, you would instead need to create a new projectile type in [[PRJ_base.xls]], then assign that projectile to your ammo or override the projectile for a specific weapon).

The longbow, shortbow, and crossbow item variation 2da's have an extra column called DefaultAmmoVariation that links to an ID in the arrow/bolt variant 2das. The default infinite ammo resource that is created when you equip that weapon will use the variant ID specified here. For example, if you had create a custom arrow variant (quiver), you could then create a custom bow variant that specifies your custom arrow variant ID in this field, and that is the quiver model that will be shown when the bow is equipped with the default infinite ammo.

Unfortunately the limitation is that non-default ammo items like Ice Arrows, Fire Arrows, etc., are actually separate ammo items and do not reflect the DefaultAmmoVariation specified in the weapon variant. These items instead have their variant defined based on their UTI definition, just like any other item. This means that when one of these ammo types is equipped, the custom quiver variant being displayed for the default ammo will disappear and the ammo item will display the generic quiver since that is the variant it uses.

There is no perfectly clean solution for handling this. You can override the item variant for all of the non-default ammo items, but that will cause your custom quiver variant to display when that ammo is equipped on any PC/NPC, regardless of the bow they are using.

Another option is to create duplicate versions of all the ammo items and change those duplicates to use your custom ammo variant. If you used these items instead of the normal ammo items, you would then see the custom quiver. Of course this has its own problems; you have to continually produce a supply of these duplicate items for yourself (since ammo is consumed), and will not be able to use "found" ammo items since they will still be off the original item type with the default variant. This option can be expanded by providing some mechanism for converting the standard types to your custom duplicate types; e.g. you could hook the [[EVENT_TYPE_EQUIP]] event and have a script that converts ammo from the vanilla version to your duplicate custom variant version when your custom weapon is also equipped.

[[Category:Projectiles]]
[[Category:Items]]
[[Category:Rules]]

Ranged Weapons and Ammunition

2010-04-09T22:02:46Z

Nezroy: /* Defining and Linking Weapons and Ammunition */

This article explains the relationship between ranged weapons and their ammunition types, how default ammo works, and how the weapon and ammunition (quiver) models and variants interrelate. This discussion applies to all four standard ranged weapons in Dragon Age: longbows, shortbows, crossbows, and staffs; and to their associated ammo types: arrows, bolts, and staff projectiles.

== Defining and Linking Weapons and Ammunition ==

Weapon types are defined in the [[BITM_base.xls]] 2da. There are two fields of importance for ranged weapons:

* Type - This is a value from the _ItemTypes worksheet; bows use [[ITEM_TYPE_WEAPON_RANGED]] and staffs use [[ITEM_TYPE_WEAPON_MAGIC]]. (I think this determines the base hit model; ranged weapon types can miss but can also crit, while magic weapon types cannot miss but also cannot crit).
* Ammo - This is a reference to the ID in [[BITM_base.xls]] of the ammunition type that the weapon uses. For instance, longbows and shortbows use the arrow ammo type, crossbows use the bolt ammo type, and staffs use the staff projectile ammo type.

Ammo types are also defined in the [[BITM_base.xls]] 2da. There are three fields of note for ammunition:

* Type - This is a value from the _ItemTypes worksheet; ammo uses [[ITEM_TYPE_AMMO]].
* DefaultResource - This is a string that matches the tag of the default ammunition item to use when no ammunition is equipped. The default arrow type is "gen_im_arrow", the default bolt is "gen_im_bolt", and the default staff projectile is "gen_im_staff_projectile". These default ammo items can all be found in the item _Global/HOLDING folder in the toolset.
* Projectile - This is the ID of an entry in the [[PRJ_base.xls]], which defines the projectile model/animation to use for the ammo as well as base modifiers to damage. The value defined here can be changed for a specific item by setting the PROJECTILE_OVERRIDE variable on that item's UTI definition to a different projectile ID. This variable should be set on the weapon that uses the ammo, not the ammo item itself.

When a ranged or magic weapon is equipped, the player's ammunition slot is automatically populated with an instance of the ammo's default resource. This item cannot be unequipped and is never consumed, which is how the infinite default arrow/bolt/staff projectiles work.

== Item and Ammunition Variations and Models ==

The model that is displayed for ammunition is independent of the model displayed for the weapon itself. In the case of arrows and bolts, the quiver models are shown whenever arrows or bolts are equipped, even if no weapon is equipped. This can be verified by equipping special ammo types like Ice Arrows with no weapon equipped.

However, when equipping an ammo using weapon, like a bow, the infinite default resource ammunition item is automatically created/equipped as well, so the quiver displays even when no specific arrows are equipped. The game is behaving as though a gen_im_arrow item is equipped, and displaying its model.

You can create new arrow and bolt variations using the [[ItemVariations.xls]] 2da, which are actually variants of the quiver model shown on the back. (TODO - I'm not sure how the location/attachment point of the quiver model is defined for arrows/bolts, and why it's not defined for staff projectiles, other than that arrows/bolts have item variation worksheets and staff projectiles don't). If you were then to create new arrow items in the toolset that use your custom quiver variant, your custom quiver would be shown when that ammo is equipped. (To actually change the arrow/bolt models shown in-flight, you would instead need to create a new projectile type in [[PRJ_base.xls]], then assign that projectile to your ammo or override the projectile for a specific weapon).

The longbow, shortbow, and crossbow item variation 2da's have an extra column called DefaultAmmoVariation that links to an ID in the arrow/bolt variant 2das. The default infinite ammo resource that is created when you equip that weapon will use the variant ID specified here. For example, if you had create a custom arrow variant (quiver), you could then create a custom bow variant that specifies your custom arrow variant ID in this field, and that is the quiver model that will be shown when the bow is equipped with the default infinite ammo.

Unfortunately the limitation is that non-default ammo items like Ice Arrows, Fire Arrows, etc., are actually separate ammo items and do not reflect the DefaultAmmoVariation specified in the weapon variant. These items instead have their variant defined based on their UTI definition, just like any other item. This means that when one of these ammo types is equipped, the custom quiver variant being displayed for the default ammo will disappear and the ammo item will display the generic quiver since that is the variant it uses.

There is no perfectly clean solution for handling this. You can override the item variant for all of the non-default ammo items, but that will cause your custom quiver variant to display when that ammo is equipped on any PC/NPC, regardless of the bow they are using.

Another option is to create duplicate versions of all the ammo items and change those duplicates to use your custom ammo variant. If you used these items instead of the normal ammo items, you would then see the custom quiver. Of course this has its own problems; you have to continually produce a supply of these duplicate items for yourself (since ammo is consumed), and will not be able to use "found" ammo items since they will still be off the original item type with the default variant. This option can be expanded by providing some mechanism for converting the standard types to your custom duplicate types; e.g. you could hook the [[EVENT_TYPE_EQUIP]] event and have a script that converts ammo from the vanilla version to your duplicate custom variant version when your custom weapon is also equipped.

[[Category:Projectiles]]
[[Category:Items]]
[[Category:Rules]]

Ranged Weapons and Ammunition

2010-04-09T22:01:28Z

Nezroy:

This article explains the relationship between ranged weapons and their ammunition types, how default ammo works, and how the weapon and ammunition (quiver) models and variants interrelate. This discussion applies to all four standard ranged weapons in Dragon Age: longbows, shortbows, crossbows, and staffs; and to their associated ammo types: arrows, bolts, and staff projectiles.

== Defining and Linking Weapons and Ammunition ==

Weapon types are defined in the [[BITM_base.xls]] 2da. There are two fields of importance for ranged weapons:

* Type - This is a value from the _ItemTypes worksheet; bows use [[ITEM_TYPE_WEAPON_RANGED]] and staffs use [[ITEM_TYPE_WEAPON_MAGIC]]. (I think this determines the base hit model; ranged weapon types can miss but can also crit, while magic weapon types cannot miss but also cannot crit).
* Ammo - This is a reference to the ID in [[BITM_base.xls]] of the ammunition type that the weapon uses. For instance, longbows and shortbows use the arrow ammo type, crossbows use the bolt ammo type, and staffs use the staff projectile ammo type.

Ammo types are also defined in the [[BITM_base.xls]] 2da. There are three fields of note for ammunition:

* Type - This is a value from the _ItemTypes worksheet; ammo uses [[ITEM_TYPE_AMMO]].
* DefaultResource - This is a string that matches the tag of the default ammunition item to use when no ammunition is equipped (for ranged weapon types) or specified in the item UTI (for magic weapon types). The default arrow type is "gen_im_arrow", the default bolt is "gen_im_bolt", and the default staff projectile is "gen_im_staff_projectile". These default ammo items can all be found in the item _Global/HOLDING folder in the toolset.
* Projectile - This is the ID of an entry in the [[PRJ_base.xls]], which defines the projectile model/animation to use for the ammo as well as base modifiers to damage. The value defined here can be changed for a specific item by setting the PROJECTILE_OVERRIDE variable on that item's UTI definition to a different projectile ID. This variable should be set on the weapon that uses the ammo, not the ammo item itself.

When a ranged or magic weapon is equipped, the player's ammunition slot is automatically populated with an instance of the ammo's default resource. This item cannot be unequipped and is never consumed, which is how the infinite default arrow/bolt/staff projectiles work.

== Item and Ammunition Variations and Models ==

The model that is displayed for ammunition is independent of the model displayed for the weapon itself. In the case of arrows and bolts, the quiver models are shown whenever arrows or bolts are equipped, even if no weapon is equipped. This can be verified by equipping special ammo types like Ice Arrows with no weapon equipped.

However, when equipping an ammo using weapon, like a bow, the infinite default resource ammunition item is automatically created/equipped as well, so the quiver displays even when no specific arrows are equipped. The game is behaving as though a gen_im_arrow item is equipped, and displaying its model.

You can create new arrow and bolt variations using the [[ItemVariations.xls]] 2da, which are actually variants of the quiver model shown on the back. (TODO - I'm not sure how the location/attachment point of the quiver model is defined for arrows/bolts, and why it's not defined for staff projectiles, other than that arrows/bolts have item variation worksheets and staff projectiles don't). If you were then to create new arrow items in the toolset that use your custom quiver variant, your custom quiver would be shown when that ammo is equipped. (To actually change the arrow/bolt models shown in-flight, you would instead need to create a new projectile type in [[PRJ_base.xls]], then assign that projectile to your ammo or override the projectile for a specific weapon).

The longbow, shortbow, and crossbow item variation 2da's have an extra column called DefaultAmmoVariation that links to an ID in the arrow/bolt variant 2das. The default infinite ammo resource that is created when you equip that weapon will use the variant ID specified here. For example, if you had create a custom arrow variant (quiver), you could then create a custom bow variant that specifies your custom arrow variant ID in this field, and that is the quiver model that will be shown when the bow is equipped with the default infinite ammo.

Unfortunately the limitation is that non-default ammo items like Ice Arrows, Fire Arrows, etc., are actually separate ammo items and do not reflect the DefaultAmmoVariation specified in the weapon variant. These items instead have their variant defined based on their UTI definition, just like any other item. This means that when one of these ammo types is equipped, the custom quiver variant being displayed for the default ammo will disappear and the ammo item will display the generic quiver since that is the variant it uses.

There is no perfectly clean solution for handling this. You can override the item variant for all of the non-default ammo items, but that will cause your custom quiver variant to display when that ammo is equipped on any PC/NPC, regardless of the bow they are using.

Another option is to create duplicate versions of all the ammo items and change those duplicates to use your custom ammo variant. If you used these items instead of the normal ammo items, you would then see the custom quiver. Of course this has its own problems; you have to continually produce a supply of these duplicate items for yourself (since ammo is consumed), and will not be able to use "found" ammo items since they will still be off the original item type with the default variant. This option can be expanded by providing some mechanism for converting the standard types to your custom duplicate types; e.g. you could hook the [[EVENT_TYPE_EQUIP]] event and have a script that converts ammo from the vanilla version to your duplicate custom variant version when your custom weapon is also equipped.

[[Category:Projectiles]]
[[Category:Items]]
[[Category:Rules]]

Ranged Weapons and Ammunition

2010-04-09T21:01:29Z

Nezroy:

This article explains the relationship between ranged weapons and their ammunition types, how default ammo works, and how the weapon and ammunition models and variants interrelate. Understanding these relations is essential for making customizing the default ranged weapons or adding new ranged weapons. This discussion applies to all four standard ranged weapons in Dragon Age: longbows, shortbows, crossbows, and staffs; and to their associated ammo types: arrows, bolts, and staff projectiles.

== Defining and Linking Weapons and Ammunition ==

Weapon types are defined in the [[BITM_base.xls]] 2da. There are two fields of importance for ranged weapons:

* Type - This is a value from the _ItemTypes worksheet; bows use [[ITEM_TYPE_WEAPON_RANGED]] and staffs use [[ITEM_TYPE_WEAPON_MAGIC]]. (I think this determines the base hit model; ranged weapon types can miss but can also crit, while magic weapon types cannot miss but also cannot crit).
* Ammo - This is a reference to the ID in [[BITM_base.xls]] of the ammunition type that the weapon uses. For instance, longbows and shortbows use the arrow ammo type, crossbows use the bolt ammo type, and staffs use the staff projectile ammo type.

Ammo types are also defined in the [[BITM_base.xls]] 2da. There are three fields of note for ammunition:

* Type - This is a value from the _ItemTypes worksheet; ammo uses [[ITEM_TYPE_AMMO]].
* DefaultResource - This is a string that matches the tag of the default ammunition item to use when no ammunition is equipped (for ranged weapon types) or specified in the item UTI (for magic weapon types). The default arrow type is "gen_im_arrow", the default bolt is "gen_im_bolt", and the default staff projectile is "gen_im_staff_projectile". These default ammo items can all be found in the item _Global/HOLDING folder in the toolset.
* Projectile - This is the ID of an entry in the [[PRJ_base.xls]], which defines the projectile model/animation to use for the ammo as well as base modifiers to damage. The value defined here can be changed for a specific item by setting the PROJECTILE_OVERRIDE variable on that item's UTI definition to a different projectile ID. This variable should be set on the weapon that uses the ammo, not the ammo item itself.

When a ranged or magic weapon is equipped, the player's ammunition slot is automatically populated with an instance of the ammo's default resource. This item cannot be unequipped and is never consumed, which is how the infinite default arrow/bolt/staff projectiles work.

== Item and Ammunition Variations and Models ==

The model that is displayed for ammunition is independent of the model displayed for the weapon itself. In the case of arrows and bolts, the quiver models are shown whenever arrows or bolts are equipped, even if no weapon is equipped. This can be verified by equipping special ammo types like Ice Arrows with no weapon equipped.

However, when equipping an ammo using weapon, like a bow, the infinite default resource ammunition item is automatically created/equipped as well, so the quiver displays even when no specific arrows are equipped. The game is behaving as though a gen_im_arrow item is equipped, and displaying its model.

You can create new arrow and bolt variations using the [[ItemVariations.xls]] 2da, which are actually variants of the quiver model shown on the back. (TODO - I'm not sure how the location/attachment point of the quiver model is defined for arrows/bolts, and why it's not defined for staff projectiles, other than that arrows/bolts have item variation worksheets and staff projectiles don't). If you were then to create new arrow items in the toolset that use your custom quiver variant, your custom quiver would be shown when that ammo is equipped. (To actually change the arrow/bolt models shown in-flight, you would instead need to create a new projectile type in [[PRJ_base.xls]], then assign that projectile to your ammo or override the projectile for a specific weapon).

The longbow, shortbow, and crossbow item variation 2da's have an extra column called DefaultAmmoVariation that links to an ID in the arrow/bolt variant 2das. The default infinite ammo resource that is created when you equip that weapon will use the variant ID specified here. For example, if you had create a custom arrow variant (quiver), you could then create a custom bow variant that specifies your custom arrow variant ID in this field, and that is the quiver model that will be shown when the bow is equipped with the default infinite ammo.

Unfortunately the limitation is that non-default ammo items like Ice Arrows, Fire Arrows, etc., are actually separate ammo items and do not reflect the DefaultAmmoVariation specified in the weapon variant. These items instead have their variant defined based on their UTI definition, just like any other item. This means that when one of these ammo types is equipped, the custom quiver variant being displayed for the default ammo will disappear and the ammo item will display the generic quiver since that is the variant it uses.

There is no perfectly clean solution for handling this. You can override the item variant for all of the non-default ammo items, but that will cause your custom quiver variant to display when that ammo is equipped on any PC/NPC, regardless of the bow they are using.

Another option is to create duplicate versions of all the ammo items and change those duplicates to use your custom ammo variant. If you used these items instead of the normal ammo items, you would then see the custom quiver. Of course this has its own problems; you have to continually produce a supply of these duplicate items for yourself (since ammo is consumed), and will not be able to use "found" ammo items since they will still be off the original item type with the default variant. This option can be expanded by providing some mechanism for converting the standard types to your custom duplicate types; e.g. you could hook the [[EVENT_TYPE_EQUIP]] event and have a script that converts ammo from the vanilla version to your duplicate custom variant version when your custom weapon is also equipped.

[[Category:Projectiles]]
[[Category:Items]]
[[Category:Rules]]

Ranged Weapons and Ammunition

2010-04-09T21:01:16Z

Nezroy: a new article describing ranged weapons and how they work with ammunition

= Ranged Weapons and Ammunition =

This article explains the relationship between ranged weapons and their ammunition types, how default ammo works, and how the weapon and ammunition models and variants interrelate. Understanding these relations is essential for making customizing the default ranged weapons or adding new ranged weapons. This discussion applies to all four standard ranged weapons in Dragon Age: longbows, shortbows, crossbows, and staffs; and to their associated ammo types: arrows, bolts, and staff projectiles.

== Defining and Linking Weapons and Ammunition ==

Weapon types are defined in the [[BITM_base.xls]] 2da. There are two fields of importance for ranged weapons:

* Type - This is a value from the _ItemTypes worksheet; bows use [[ITEM_TYPE_WEAPON_RANGED]] and staffs use [[ITEM_TYPE_WEAPON_MAGIC]]. (I think this determines the base hit model; ranged weapon types can miss but can also crit, while magic weapon types cannot miss but also cannot crit).
* Ammo - This is a reference to the ID in [[BITM_base.xls]] of the ammunition type that the weapon uses. For instance, longbows and shortbows use the arrow ammo type, crossbows use the bolt ammo type, and staffs use the staff projectile ammo type.

Ammo types are also defined in the [[BITM_base.xls]] 2da. There are three fields of note for ammunition:

* Type - This is a value from the _ItemTypes worksheet; ammo uses [[ITEM_TYPE_AMMO]].
* DefaultResource - This is a string that matches the tag of the default ammunition item to use when no ammunition is equipped (for ranged weapon types) or specified in the item UTI (for magic weapon types). The default arrow type is "gen_im_arrow", the default bolt is "gen_im_bolt", and the default staff projectile is "gen_im_staff_projectile". These default ammo items can all be found in the item _Global/HOLDING folder in the toolset.
* Projectile - This is the ID of an entry in the [[PRJ_base.xls]], which defines the projectile model/animation to use for the ammo as well as base modifiers to damage. The value defined here can be changed for a specific item by setting the PROJECTILE_OVERRIDE variable on that item's UTI definition to a different projectile ID. This variable should be set on the weapon that uses the ammo, not the ammo item itself.

When a ranged or magic weapon is equipped, the player's ammunition slot is automatically populated with an instance of the ammo's default resource. This item cannot be unequipped and is never consumed, which is how the infinite default arrow/bolt/staff projectiles work.

== Item and Ammunition Variations and Models ==

The model that is displayed for ammunition is independent of the model displayed for the weapon itself. In the case of arrows and bolts, the quiver models are shown whenever arrows or bolts are equipped, even if no weapon is equipped. This can be verified by equipping special ammo types like Ice Arrows with no weapon equipped.

However, when equipping an ammo using weapon, like a bow, the infinite default resource ammunition item is automatically created/equipped as well, so the quiver displays even when no specific arrows are equipped. The game is behaving as though a gen_im_arrow item is equipped, and displaying its model.

You can create new arrow and bolt variations using the [[ItemVariations.xls]] 2da, which are actually variants of the quiver model shown on the back. (TODO - I'm not sure how the location/attachment point of the quiver model is defined for arrows/bolts, and why it's not defined for staff projectiles, other than that arrows/bolts have item variation worksheets and staff projectiles don't). If you were then to create new arrow items in the toolset that use your custom quiver variant, your custom quiver would be shown when that ammo is equipped. (To actually change the arrow/bolt models shown in-flight, you would instead need to create a new projectile type in [[PRJ_base.xls]], then assign that projectile to your ammo or override the projectile for a specific weapon).

The longbow, shortbow, and crossbow item variation 2da's have an extra column called DefaultAmmoVariation that links to an ID in the arrow/bolt variant 2das. The default infinite ammo resource that is created when you equip that weapon will use the variant ID specified here. For example, if you had create a custom arrow variant (quiver), you could then create a custom bow variant that specifies your custom arrow variant ID in this field, and that is the quiver model that will be shown when the bow is equipped with the default infinite ammo.

Unfortunately the limitation is that non-default ammo items like Ice Arrows, Fire Arrows, etc., are actually separate ammo items and do not reflect the DefaultAmmoVariation specified in the weapon variant. These items instead have their variant defined based on their UTI definition, just like any other item. This means that when one of these ammo types is equipped, the custom quiver variant being displayed for the default ammo will disappear and the ammo item will display the generic quiver since that is the variant it uses.

There is no perfectly clean solution for handling this. You can override the item variant for all of the non-default ammo items, but that will cause your custom quiver variant to display when that ammo is equipped on any PC/NPC, regardless of the bow they are using.

Another option is to create duplicate versions of all the ammo items and change those duplicates to use your custom ammo variant. If you used these items instead of the normal ammo items, you would then see the custom quiver. Of course this has its own problems; you have to continually produce a supply of these duplicate items for yourself (since ammo is consumed), and will not be able to use "found" ammo items since they will still be off the original item type with the default variant. This option can be expanded by providing some mechanism for converting the standard types to your custom duplicate types; e.g. you could hook the [[EVENT_TYPE_EQUIP]] event and have a script that converts ammo from the vanilla version to your duplicate custom variant version when your custom weapon is also equipped.

[[Category:Projectiles]]
[[Category:Items]]
[[Category:Rules]]

Talk:Texture Formats

2010-03-26T15:40:53Z

Nezroy:

To be clear.
A 'black and white normal map' is actually a 'displacement map.' I think it's confusing that you call a b&w texture, that fakes geometry height, a 'normal map' and
a RGB texture, that fakes geometry height and position, a 'RGB normal map'. B&W = displacement. RGB = normal ''-Freebeers''

*No its actually a normal map too. Its a normal map because it stores normals. That some are colorful, others are not is of no matter. Its just grey because of different channel assignment. I think the descriptions RGB and B&W could get a workover. RGB is the standard format. B&W is the Bioware format. [[User:Eshme|Eshme]] 06:09, 8 February 2010 (UTC)

== Specular Maps ==

It appears to me that the specular map RGB channels are not 3 unrelated maps as implied by the 4 packed-maps descriptin, but instead simply control the color of the specular highlight. The alpha seems to control the intensity of the highlight. Can anyone else confirm or rebuke that based on their experience/experiments? [[User:Nezroy|Nezroy]] 15:40, 26 March 2010 (UTC)

Talk:Texture Formats

2010-03-26T15:40:36Z

Nezroy: specular map discussion

To be clear.
A 'black and white normal map' is actually a 'displacement map.' I think it's confusing that you call a b&w texture, that fakes geometry height, a 'normal map' and
a RGB texture, that fakes geometry height and position, a 'RGB normal map'. B&W = displacement. RGB = normal ''-Freebeers''

*No its actually a normal map too. Its a normal map because it stores normals. That some are colorful, others are not is of no matter. Its just grey because of different channel assignment. I think the descriptions RGB and B&W could get a workover. RGB is the standard format. B&W is the Bioware format. [[User:Eshme|Eshme]] 06:09, 8 February 2010 (UTC)

=== Specular Maps ===

It appears to me that the specular map RGB channels are not 3 unrelated maps as implied by the 4 packed-maps descriptin, but instead simply control the color of the specular highlight. The alpha seems to control the intensity of the highlight. Can anyone else confirm or rebuke that based on their experience/experiments? [[User:Nezroy|Nezroy]] 15:40, 26 March 2010 (UTC)

Prefixes in use

2010-03-01T17:42:03Z

Nezroy: alphabetization FTW

Potential conflict between add-ins can be reduced by using a unique prefix for resource names (and a similar suffix for M2DA tables).

We don't know for sure which prefixes Bioware may need to use in future, but we can reduce conflict between community offerings by registering our intentions here.

WARNING - no doubt Bioware has already allocated additional prefixes for DLC and future releases, so registering here does not guarantee that your prefix is unique.

{| class="wikitable" border="1"
|-
! Prefix
! Used by
|-
| APL
| BIOWARE
|-
| BDC
| BIOWARE
|-
| BDN
| BIOWARE
|-
| BEC
| BIOWARE
|-
| BED
| BIOWARE
|-
| BHM
| BIOWARE
|-
| BHN
| BIOWARE
|-
| CAM
| BIOWARE
|-
| CIR
| BIOWARE
|-
| COC
| [http://social.bioware.com/project/178/ Crown of Creation]
|-
| DEN
| BIOWARE
|-
| EPI
| BIOWARE
|-
| GEN
| BIOWARE
|-
| LOT
| BIOWARE
|-
| NEZ
| All of [http://social.bioware.com/profile/20696#bw_projects nezroy's projects].
|-
| NTB
| BIOWARE
|-
| ORZ
| BIOWARE
|-
| PRE
| BIOWARE
|-
| RAN
| BIOWARE
|-
| URN
| BIOWARE
|-
| VWK
| Magic - [http://social.bioware.com/project/1429/ Void Walker]
|}

Prefixes in use

2010-03-01T17:41:35Z

Nezroy: adding nez for nezroy

Potential conflict between add-ins can be reduced by using a unique prefix for resource names (and a similar suffix for M2DA tables).

We don't know for sure which prefixes Bioware may need to use in future, but we can reduce conflict between community offerings by registering our intentions here.

WARNING - no doubt Bioware has already allocated additional prefixes for DLC and future releases, so registering here does not guarantee that your prefix is unique.

{| class="wikitable" border="1"
|-
! Prefix
! Used by
|-
| APL
| BIOWARE
|-
| BDC
| BIOWARE
|-
| BDN
| BIOWARE
|-
| BEC
| BIOWARE
|-
| BED
| BIOWARE
|-
| BHM
| BIOWARE
|-
| BHN
| BIOWARE
|-
| CAM
| BIOWARE
|-
| CIR
| BIOWARE
|-
| COC
| [http://social.bioware.com/project/178/ Crown of Creation]
|-
| DEN
| BIOWARE
|-
| EPI
| BIOWARE
|-
| GEN
| BIOWARE
|-
| LOT
| BIOWARE
|-
| NTB
| BIOWARE
|-
| ORZ
| BIOWARE
|-
| PRE
| BIOWARE
|-
| RAN
| BIOWARE
|-
| URN
| BIOWARE
|-
| VWK
| Magic - [http://social.bioware.com/project/1429/ Void Walker]
|-
| NEZ
| All of [http://social.bioware.com/profile/20696#bw_projects nezroy's projects].
|}

Talk:Reskinning an item tutorial

2010-02-26T18:01:33Z

Nezroy: addressing q about ERFs

Thanks for the tutorial on reskinning an item!

One question: How do I ''recolor'' a texture? The colors that the characters are wearing in-game seem to have nothing to do with the colors of the textures in the .dds files.

The main mage robe texture file, pf_rob_appb_0dl2.dds, has very little color, and if I recolor it, as you'd expect, nothing happens. And if I look at pf_rob_appb_0t.dds, it's intense shades of red, blue, and green, which seem designed to tell the game where to put various colors, rather than which colors those are. So where do the specific colors come from?

I've recolored a lot of files for ''The Witcher,'' so I know how to recolor a .dds file. But in ''The Witcher,'' you get whatever color you've made the texture. Where are the colors stored for ''Dragon Age''?

My mage has an orange-and-green set of robes, and I'd like a different color scheme.

Thanks!

Corylea
:You'll want to read up on the [[Material Tint System]] and check out [[Tutorial:_Creating_recolors_of_existing_items|this tutorial]] and [[Tutorial:_Understanding_Tints:_Overriding_Defaults_&_Creating_New_Ones|this tutorial]] on tinting. [[User:Nezroy|Nezroy]] 18:00, 26 February 2010 (UTC)

Where are the files for the Blood Dragon Armor called?

What program do you use to open the ERFs?
---Skyintheeye
:The toolset can open ERFs. Just use the File->Open command and locate the ERF to open. Then right-click on a file in the list and select "Extract Resource" (or alternatively you can use "Extract All Resources" to dump the contents of the entire ERF somewhere). [[User:Nezroy|Nezroy]] 18:01, 26 February 2010 (UTC)

Talk:Reskinning an item tutorial

2010-02-26T18:00:18Z

Nezroy: addressing corylea question about tints/colors

2DA ranges in use

2010-02-25T10:30:03Z

Nezroy: fixing ts_material spacing

This page is meant to enumerate row ID ranges that are used by the main game and by various popular addins, to avoid accidental overlap. Note that there's no need for 2DA row IDs to be sequential, so you can use very large row ID numbers to reduce the chances of collision.

Version 1.0 of the toolset had a bug in ExcelProcessor that caused problems with high row ID numbers, but this has been fixed in subsequent releases. See [[Bug: ExcelProcessor doesn't handle row IDs above 8.3 million correctly|the bug report]].

As of now there is a bug that prevents ID's above 255 to be used for some M2DA's. Most certainly it is ''"only"'' [[ItemVariations.xls]] related. See [[Bug: High M2DA ID ranges might work in the toolset, but not in game|Bug report]].

== ABI_base ==

According to the [[ABI_base]] page under the ''tooltipstrref'' column, anything over 500000 is considered a debuff. This would limit the range a fair amount.

{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 200262'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680050
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|}

----

== ANIM_base ==

{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| 65000 - 65002
| BioSpirit's [http://social.bioware.com/project/1647/ Hilltop Under Siege]
|}

----

== APR_base ==

Note that there is a bug involving this 2DA: [[Bug: APR base maximum M2DA row ID is 65535 in the toolset]]

{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 90'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 65000 - 65001
| BioSpirit's [http://social.bioware.com/project/1647/ Hilltop Under Siege]
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|}

----

== BITM_base and ItemStats_ ==

{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| 30000 - 30500
| Ambaryerno - [http://social.bioware.com/project/415/ Arms and Armor]
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|}

----

== crafting_recipe_types ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 7'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680010
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|}

----

== crafting_recipes ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 91'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680999
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|}

----

== guitypes ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 5680000 - 5680010
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|}

----

== itemprps ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 10022'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680050
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 536873321 - 536873322
| Elys' [http://social.bioware.com/project/522/ Mysterious Gifts]
|}

----

== itemsets ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 30'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680500
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 1405261000 - 1405261999
| nezroy - [http://social.bioware.com/project/1834/ Warden Shields], [http://www.dragonagenexus.com/downloads/file.php?id=793 Leliana Item Set]
|}

----

== M2DA_base ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 1016, 2000 - 2010, 10011 - 10142, ...? '''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680050
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 6000000 - 6000050
| TreDawn - [http://social.bioware.com/project/1750/ Nesiara Companion]
|-
| 7000000 - 7000050
| FtG - [http://social.bioware.com/project/1688/ UI Mod]
|-
| 7777770 - 7777799
| Magic - [http://social.bioware.com/project/1429/ Void Walker] (M2DA prefix: VWK)
|-
| 9000000 - 9000050
| Ambaryerno - [http://social.bioware.com/project/415/ Arms and Armor]
|-
| 1140150041 - 1140150091
| DLAN_Immortality - [http://social.bioware.com/project/789/ Ser Gilmore NPC]
|}

----

== materialrules ==
{| class="wikitable" border="1"
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 536873321 - 536873323
| Elys' [http://social.bioware.com/project/522/ Mysterious Gifts]
|-
| 1405261000 - 1405261999
| nezroy - [http://social.bioware.com/project/1834/ Warden Shields], [http://www.dragonagenexus.com/downloads/file.php?id=793 Leliana Item Set]
|}

----

== materialtypes ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 88'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680199
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 536873321 - 536873340
| Elys' [http://social.bioware.com/project/522/ Mysterious Gifts]
|-
| 1405261000 - 1405261999
| nezroy - [http://social.bioware.com/project/1834/ Warden Shields], [http://www.dragonagenexus.com/downloads/file.php?id=793 Leliana Item Set]
|}

----
== PartyPicker ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 11'''
| '''Bioware - Main campaign'''
|-
| '''????'''
| '''Bioware - reserved'''
|-
| 101-199
| [http://social.bioware.com/project/178/ Crown of Creation]
|}

----

== PRCSCR ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 10100000
| Camp [http://social.bioware.com/project/463/ storage chest]
|-
| 10100100-10100110
| Eshme's [http://social.bioware.com/project/1929/ Sleeping Tent]
|-
| 5680000 - 5680020
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 6000000 - 6000050
| TreDawn - [http://social.bioware.com/project/1750/ Nesiara Companion]
|-
| 1140150041 - 1140150091
| DLAN_Immortality - [http://social.bioware.com/project/789/ Ser Gilmore NPC]
|-
| 1405261000 - 1405261999
| nezroy - [http://social.bioware.com/project/1834/ Warden Shields], [http://www.dragonagenexus.com/downloads/file.php?id=793 Leliana Item Set]
|}

----

== placeable_types ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 43050-43061
| Eshme's [http://social.bioware.com/project/1929/ Sleeping Tent] (Greater 65535 is showing bugs so this is until it is fixed)
|-
| 43062-43065
| BioSpirit's [http://social.bioware.com/project/1647/ Hilltop Under Siege]
|-
| 2696549 - 2696700
| PavelNovotny - [http://social.bioware.com/project/517/ Gay Bars of Ferelden] (NOTE: I'm using the 6000-6200 range until Bioware fixes the bug which prevents m2da ID ranges above 900000 from showing up in game.)
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|}

----

== tint_override ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| 500 - 520
| PavelNovotny - [http://social.bioware.com/project/517/ Gay Bars of Ferelden]
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|}

----

== ts_material ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| 1405261000 - 1405261999
| nezroy - [http://social.bioware.com/project/1834/ Warden Shields], [http://www.dragonagenexus.com/downloads/file.php?id=793 Leliana Item Set]
|}

----

== vfx_base ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 5680000 - 5680010
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 5680011 - 5680019
| BioSpirit's [http://social.bioware.com/project/1647/ Hilltop Under Siege]
|}

[[Category:2DAs]]

Talk:2DA ranges in use

2010-02-25T10:28:59Z

Nezroy: variant id ranges?

Are we not bothering with reserving variant ranges until the >255 bug is fixed? Or should we start a land grab for this valuable space? I've been using variant IDs of 137-140 in my current stuff. [[User:Nezroy|Nezroy]] 10:28, 25 February 2010 (UTC)

2DA ranges in use

2010-02-25T10:26:26Z

Nezroy: added ts_material table, and some reserved ranges for me

2DA ranges in use

2010-02-21T09:01:01Z

Nezroy: adding nezroy project id ranges

This page is meant to enumerate row ID ranges that are used by the main game and by various popular addins, to avoid accidental overlap. Note that there's no need for 2DA row IDs to be sequential, so you can use very large row ID numbers to reduce the chances of collision.

Version 1.0 of the toolset had a bug in ExcelProcessor that caused problems with high row ID numbers, but this has been fixed in subsequent releases. See [[Bug: ExcelProcessor doesn't handle row IDs above 8.3 million correctly|the bug report]].

As of now there is a bug that prevents ID's above 255 to be used for some M2DA's. Most certainly it is ''"only"'' [[ItemVariations.xls]] related. See [[Bug: High M2DA ID ranges might work in the toolset, but not in game|Bug report]].

== ABI_base ==

According to the [[ABI_base]] page under the ''tooltipstrref'' column, anything over 500000 is considered a debuff. This would limit the range a fair amount.

{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 200262'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680050
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|}

----

== ANIM_base ==

{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| 65000 - 65002
| BioSpirit's [http://social.bioware.com/project/1647/ Hilltop Under Siege]
|}

----

== APR_base ==

Note that there is a bug involving this 2DA: [[Bug: APR base maximum M2DA row ID is 65535 in the toolset]]

{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 90'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 65000 - 65001
| BioSpirit's [http://social.bioware.com/project/1647/ Hilltop Under Siege]
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|}

----

== BITM_base and ItemStats_ ==

{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| 30000 - 30500
| Ambaryerno - [http://social.bioware.com/project/415/ Arms and Armor]
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|}

----

== crafting_recipe_types ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 7'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680010
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|}

----

== crafting_recipes ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 91'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680999
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|}

----

== guitypes ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 5680000 - 5680010
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|}

----

== itemprps ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 10022'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680050
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 536873321 - 536873322
| Elys' [http://social.bioware.com/project/522/ Mysterious Gifts]
|}

----

== itemsets ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 30'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680500
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 1405261000 - 1405261999
| nezroy - [http://social.bioware.com/project/1834/ Warden Shields]
|}

----

== M2DA_base ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 1016, 2000 - 2010, 10011 - 10142, ...? '''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680050
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 6000000 - 6000050
| TreDawn - [http://social.bioware.com/project/1750/ Nesiara Companion]
|-
| 7000000 - 7000050
| FtG - [http://social.bioware.com/project/1688/ UI Mod]
|-
| 7777770 - 7777799
| Magic - [http://social.bioware.com/project/1429/ Void Walker] (M2DA prefix: VWK)
|-
| 9000000 - 9000050
| Ambaryerno - [http://social.bioware.com/project/415/ Arms and Armor]
|-
| 1140150041 - 1140150091
| DLAN_Immortality - [http://social.bioware.com/project/789/ Ser Gilmore NPC]
|}

----

== materialrules ==
{| class="wikitable" border="1"
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 536873321 - 536873323
| Elys' [http://social.bioware.com/project/522/ Mysterious Gifts]
|}

----

== materialtypes ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 88'''
| '''Bioware - Main campaign'''
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 5680000 - 5680199
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 536873321 - 536873340
| Elys' [http://social.bioware.com/project/522/ Mysterious Gifts]
|-
| 1405261000 - 1405261999
| nezroy - [http://social.bioware.com/project/1834/ Warden Shields]
|}

----
== PartyPicker ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 11'''
| '''Bioware - Main campaign'''
|-
| '''????'''
| '''Bioware - reserved'''
|-
| 101-199
| [http://social.bioware.com/project/178/ Crown of Creation]
|}

----

== PRCSCR ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|-
| 10100000
| Camp [http://social.bioware.com/project/463/ storage chest]
|-
| 10100100-10100110
| Eshme's [http://social.bioware.com/project/1929/ Sleeping Tent]
|-
| 5680000 - 5680010
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 6000000 - 6000050
| TreDawn - [http://social.bioware.com/project/1750/ Nesiara Companion]
|-
| 1140150041 - 1140150091
| DLAN_Immortality - [http://social.bioware.com/project/789/ Ser Gilmore NPC]
|-
| 1405261000 - 1405261999
| nezroy - [http://social.bioware.com/project/1834/ Warden Shields]
|}

----

== placeable_types ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 43050-43061
| Eshme's [http://social.bioware.com/project/1929/ Sleeping Tent] (Greater 65535 is showing bugs so this is until it is fixed)
|-
| 43062-43065
| BioSpirit's [http://social.bioware.com/project/1647/ Hilltop Under Siege]
|-
| 2696549 - 2696700
| PavelNovotny - [http://social.bioware.com/project/517/ Gay Bars of Ferelden] (NOTE: I'm using the 6000-6200 range until Bioware fixes the bug which prevents m2da ID ranges above 900000 from showing up in game.)
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|}

----

== tint_override ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| 500 - 520
| PavelNovotny - [http://social.bioware.com/project/517/ Gay Bars of Ferelden]
|-
| 30000000-40000000
| MCC's Senderfall: The Last Bastion (To author: unreasonable range, please correct)
|}

----

== vfx_base ==
{| class="wikitable" border="1"
|-
! Range
! Used by
|-
| '''0 - 1000000'''
| '''Bioware - reserved'''
|-
| 5680000 - 5680010
| Phaenan's [http://social.bioware.com/project/672/ The Winter Forge]
|-
| 5680011 - 5680019
| BioSpirit's [http://social.bioware.com/project/1647/ Hilltop Under Siege]
|}

[[Category:2DAs]]