Difference between revisions of "PRCSCR.xls"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(fix name of 2da)
m (→‎Example: Applying CSS style)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
Whenever a player enters an area in an area list in this M2DA the associated script will be run. A modder can therefore include a script with his mod that will be run when the player enters an existing area that he didn't create. This script can freely add or remove placeables and creatures and perform whatever other modifications to the area that a script is capable of doing.
 
Whenever a player enters an area in an area list in this M2DA the associated script will be run. A modder can therefore include a script with his mod that will be run when the player enters an existing area that he didn't create. This script can freely add or remove placeables and creatures and perform whatever other modifications to the area that a script is capable of doing.
  
−
Note that the script will be run every time the player enters the area, so you'll want to have an associated plot flag to ensure that the changes are only made once.  
+
The Worksheets/M2DA's name should always start with "PRCSCR_". Whatever suffix you enter is your choice ,as the game will still find the file.  
 +
 
 +
:''See also: [[PRCSCR]]''
 +
 
 +
== Properties ==
  
 
{{2da start|PRCSCR_}}
 
{{2da start|PRCSCR_}}
−
{{2da column|AreaListName|string|a string that identifies a specific area list, or the special keyword "any".}}
+
{{2da column|AreaListName|string|a string that identifies a specific 'AreaList' property of any Area, or the special keyword "any".}}
 
{{2da column|Script|string|the name of a script file to run}}
 
{{2da column|Script|string|the name of a script file to run}}
 
{{2da end}}
 
{{2da end}}
  
−
[[Category:2DAs]]
+
Using "any" in the AreaListName column will trigger the specified script when entering or loading any area.
 +
 
 +
'''Note''': Make sure that the ID ranges you choose don't conflict with ones already in use. "[[2DA ranges in use]]"
 +
 
 +
 
 +
<!-- Adding an example, in regard to how important this file is -->
 +
<!-- Not sure if it makes sense if only this page gets one, but its something... -->
 +
== Example ==
 +
 
 +
{| class="wikitable" width=700px
 +
|+ '''Example Excel Worksheet "PRCSCR_mygnomemod"'''
 +
! ID !! AreaListName !! Script
 +
|-
 +
! ''int'' !! ''string'' !! ''string''
 +
|-
 +
| 1200300 || cam100ar_camp_plains || mygnome_script
 +
|}
 +
 
 +
'''Notes:'''
 +
 
 +
#The worksheets name must have a unique suffix, to stand out from other Mods. This can be any you like.
 +
#Use any unique ID, by taking into account that Bioware reserves 0-1million.
 +
#"cam100ar_camp_plains" is the normal Camp Area, this is where the Script will be run.
 +
#"mygnome_script" is the Script to run, without "nss" file extenstion.
 +
 
 +
[[Category:XLS files]]
 +
{{Languages}}

Latest revision as of 18:24, 3 August 2011

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

The Worksheets/M2DA's name should always start with "PRCSCR_". Whatever suffix you enter is your choice ,as the game will still find the file.

See also: PRCSCR

Properties

Column Type Description
ID int A number that uniquely identifies the entry (unless creating an M2DA override). ID numbers are listed from smallest to highest within a given file but do not need to be consecutive.
AreaListName string a string that identifies a specific 'AreaList' property of any Area, or the special keyword "any".
Script string the name of a script file to run

Using "any" in the AreaListName column will trigger the specified script when entering or loading any area.

Note: Make sure that the ID ranges you choose don't conflict with ones already in use. "2DA ranges in use"


Example

Example Excel Worksheet "PRCSCR_mygnomemod"
ID AreaListName Script
int string string
1200300 cam100ar_camp_plains mygnome_script

Notes:

  1. The worksheets name must have a unique suffix, to stand out from other Mods. This can be any you like.
  2. Use any unique ID, by taking into account that Bioware reserves 0-1million.
  3. "cam100ar_camp_plains" is the normal Camp Area, this is where the Script will be run.
  4. "mygnome_script" is the Script to run, without "nss" file extenstion.


Language: English  • русский
Retrieved from "http://datoolset.net/mw/index.php?title=PRCSCR.xls&oldid=16769"