Difference between revisions of "Job board"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) (imported from extranet) |
BryanDerksen (Talk | contribs) (update and format) |
||
| Line 3: | Line 3: | ||
Chanter's boards are created largely through the use of [[plot]]s and [[2DA]]s. The board itself should require only a script that calls the following function when it receives the PLACEABLE_ACTION_EXAMINE event: | Chanter's boards are created largely through the use of [[plot]]s and [[2DA]]s. The board itself should require only a script that calls the following function when it receives the PLACEABLE_ACTION_EXAMINE event: | ||
| + | <dascript> | ||
ShowChantersGUI(integer BoardID); | ShowChantersGUI(integer BoardID); | ||
| + | </dascript> | ||
== JobBoards == | == JobBoards == | ||
| Line 9: | Line 11: | ||
The BoardID number for any particular board is defined in the 2DA "JobBoards", found in JobBoards.xls. This 2DA also defines a few things about what a given board looks like. | The BoardID number for any particular board is defined in the 2DA "JobBoards", found in JobBoards.xls. This 2DA also defines a few things about what a given board looks like. | ||
| − | + | {{2da start}} | |
| − | + | {{2da column| LABEL |string| A string used by the toolset internally}} | |
| − | + | {{2da column| Texture |resource| the background texture displayed by the job board GUI}} | |
| − | + | {{2da column| HeaderStrId |int| a [[string ID]] for a text header at the top of the board}} | |
| − | + | {{2da column| ModuleRef |string| The campaign that owns this board}} | |
| − | + | {{2da column| ShowDonationButton |int| {{undocumented}} }} | |
| − | + | {{2da column| DonationScript |resource| script to be fired for each donation. Amount donated should be int param 0}} | |
| − | + | {{2da column| DonationMsgStrId |int| String for the message box that is shown when the donation is accepted}} | |
| + | {{2da column| HeaderTintIndex|int| | ||
| + | *1 - chantry | ||
| + | *2 - mage | ||
| + | *3 - blackstone | ||
| + | *4 - rogue | ||
| + | }} | ||
| + | {{2da end}} | ||
| − | + | '''Note: I'm not sure if the donation system is functional, none of the boards in the game are set up for it and the donation script listed for them is nonexistent.''' | |
== JobBoardPlots == | == JobBoardPlots == | ||
| Line 24: | Line 33: | ||
This second 2DA is responsible for placing entries on job boards. | This second 2DA is responsible for placing entries on job boards. | ||
| − | + | {{2da start}} | |
| − | + | {{2da column| LABEL | comment | }} | |
| − | + | {{2da column| PlotRef | resource| The plot resource that this particular entry belongs to}} | |
| − | + | {{2da column| BoardId| int| This ID number corresponds to the board's row ID in the JobBoards 2DA.}} | |
| − | + | {{2da column| VisibleFlag |int| A flag ID number from the plot referenced in PlotRef. When this plot flag is ''set'', the flag's journal entry will be shown as an entry on the job board. The title given to the entry on the board will be the "Name" property of the PlotRef plot, so you should probably have a separate plot file for each entry on the board.}} | |
| − | + | {{2da column| AcceptedFlag |int| A flag ID number from the plot referenced in PlotRef. When the job is accepted by the player, this flag is set.}} | |
| − | + | {{2da column| OfferID |int| OfferID for PRC Offers (i.e. ID of the offer for the new PRC content, not the ID of the PRC package itself). }} | |
| − | + | {{2da column| Comments | comment | }} | |
| + | {{2da end}} | ||
To make the quest offer disappear from the board once it's been accepted by the player, you'll need to have a plot script catch the AcceptedFlag set event and unset the VisibleFlag plot entry. | To make the quest offer disappear from the board once it's been accepted by the player, you'll need to have a plot script catch the AcceptedFlag set event and unset the VisibleFlag plot entry. | ||
Revision as of 22:33, 19 July 2009
A Chanter's board is a type of placeable used to represent a bulletin board where jobs or quests are posted for the player. Quests on chanter's boards are generally minor side quests of no direct relevance to the plot.
Chanter's boards are created largely through the use of plots and 2DAs. The board itself should require only a script that calls the following function when it receives the PLACEABLE_ACTION_EXAMINE event:
ShowChantersGUI(integer BoardID);
JobBoards
The BoardID number for any particular board is defined in the 2DA "JobBoards", found in JobBoards.xls. This 2DA also defines a few things about what a given board looks like.
| 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. |
| LABEL | string | A string used by the toolset internally |
| Texture | resource | the background texture displayed by the job board GUI |
| HeaderStrId | int | a string ID for a text header at the top of the board |
| ModuleRef | string | The campaign that owns this board |
| ShowDonationButton | int | [Undocumented] |
| DonationScript | resource | script to be fired for each donation. Amount donated should be int param 0 |
| DonationMsgStrId | int | String for the message box that is shown when the donation is accepted |
| HeaderTintIndex | int |
|
Note: I'm not sure if the donation system is functional, none of the boards in the game are set up for it and the donation script listed for them is nonexistent.
JobBoardPlots
This second 2DA is responsible for placing entries on job boards.
| 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. |
| LABEL | comment | |
| PlotRef | resource | The plot resource that this particular entry belongs to |
| BoardId | int | This ID number corresponds to the board's row ID in the JobBoards 2DA. |
| VisibleFlag | int | A flag ID number from the plot referenced in PlotRef. When this plot flag is set, the flag's journal entry will be shown as an entry on the job board. The title given to the entry on the board will be the "Name" property of the PlotRef plot, so you should probably have a separate plot file for each entry on the board. |
| AcceptedFlag | int | A flag ID number from the plot referenced in PlotRef. When the job is accepted by the player, this flag is set. |
| OfferID | int | OfferID for PRC Offers (i.e. ID of the offer for the new PRC content, not the ID of the PRC package itself). |
| Comments | comment |
To make the quest offer disappear from the board once it's been accepted by the player, you'll need to have a plot script catch the AcceptedFlag set event and unset the VisibleFlag plot entry.
JobBoardPlots is an M2DA so it's easy to add new side quests to existing Chanter's boards.
