Job board - Revision history

Ladyofpayne: /* See Also */

2014-07-10T08:27:53Z

‎See Also

Ladyofpayne: /* See Also */

2014-07-10T08:25:10Z

‎See Also

Sunjammer: Adding section

2011-10-16T16:00:29Z

Adding section

Sunjammer: Extracted 2da information

2011-10-16T11:40:43Z

Extracted 2da information

Sunjammer: moved Chanter's board to Job board

2011-10-16T11:30:36Z

moved Chanter's board to Job board

BryanDerksen: category

2010-02-08T22:04:59Z

BryanDerksen: categories

2010-01-28T17:41:02Z

BryanDerksen: fix a script

2009-07-30T19:59:18Z

fix a script

BryanDerksen: 2da start

2009-07-27T22:55:00Z

2da start

BryanDerksen: update and format

2009-07-19T21:33:30Z

update and format

← Older revision		Revision as of 08:27, 10 July 2014
Line 17:		Line 17:
	[[Category:Plots]]		[[Category:Plots]]
	[[Category:Placeables]]		[[Category:Placeables]]
		+	[[Category:Tutorials]]

@@ Line 13: / Line 13: @@
 * [[JobBoards.xls]]
 [[Category:Plots]]
 [[Category:Placeables]]

@@ Line 3: / Line 3: @@
 Job boards are created largely through the use of [[plot]]s and [[2DA]]s. The board itself should require only a script that calls the [[ShowChantersGUI]] function when it receives the [[PLACEABLE_ACTION_*|PLACEABLE_ACTION_EXAMINE]] action in the [[EVENT_TYPE_USE]] event.
-== 2da files ==
+== 2da Files ==
-* [[JobBoards 2da]]: 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.
+* [[JobBoards 2da]]: The '''BoardID'''  number for any particular board is the row number in this 2da file. This 2DA also defines a few things about what a  given board looks like.
 * [[JobBoardPlots 2da]]: This 2DA is responsible for placing entries on job boards. To make the quest offer disappear from the board once it has been accepted by the player,  you will need to have a plot script catch the '''AcceptedFlag''' set event.
 The '''JobBoardPlots''' 2da is defined as an m2da so it is easy to add new side quests to to one of the job boards in the [[Single Player]] module.
 [[Category:Plots]]
 [[Category:Placeables]]

@@ Line 1: / Line 1: @@
-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.
+A [[job board]] is a type of [[placeable]] used to represent a bulletin board where jobs or quests are posted for the player. Quests on a job board are generally minor side quests of no  direct relevance to the plot.
-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:
+Job boards are created largely through the use of [[plot]]s and [[2DA]]s. The board itself should require only a script that calls the [[ShowChantersGUI]] function when it receives the [[PLACEABLE_ACTION_*|PLACEABLE_ACTION_EXAMINE]] action in the [[EVENT_TYPE_USE]] event.
-<dascript>
+== 2da files ==
-ShowChantersGUI(int BoardID);
-</dascript>
-== JobBoards ==
+* [[JobBoards 2da]]: 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.
+The '''JobBoardPlots''' 2da is defined as an m2da so it is easy to add new side quests to to one of the job boards in the [[Single Player]] module.
 [[Category:Plots]]
 [[Category:Placeables]]

← Older revision		Revision as of 22:04, 8 February 2010
Line 49:		Line 49:
	[[Category:XLS files]]		[[Category:XLS files]]
	[[Category:Plots]]		[[Category:Plots]]
		+	[[Category:Placeables]]

← Older revision	Revision as of 11:30, 16 October 2011
(No difference)

← Older revision		Revision as of 17:41, 28 January 2010
Line 47:		Line 47:
	JobBoardPlots is an M2DA so it's easy to add new side quests to existing Chanter's boards.		JobBoardPlots is an M2DA so it's easy to add new side quests to existing Chanter's boards.

−	[[Category:~~2DAs~~]]	+	[[Category:XLS files]]
		+	[[Category:Plots]]

@@ Line 11: / 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.
-{{2da start}}
+{{2da start|JobBoards}}
 {{2da column| LABEL |string| A string used by the toolset internally}}
 {{2da column| Texture |resource| the background texture displayed by the job board GUI}}
@@ Line 33: / Line 33: @@
 This second 2DA is responsible for placing entries on job boards.
-{{2da start}}
+{{2da start|JobBoardPlots}}
 {{2da column| LABEL | comment | }}
 {{2da column| PlotRef | resource| The plot resource that this particular entry belongs to}}

@@ 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:
 ShowChantersGUI(integer BoardID);
 == 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.
-*ID - The unique ID number for any given job board
+{{2da start}}
-*LABEL - A string used by the toolset internally
+{{2da column| LABEL |string| A string used by the toolset internally}}
-*Texture - the background texture displayed by the job board GUI
+{{2da column| Texture |resource| the background texture displayed by the job board GUI}}
-*HeaderStrId - a [string ID] for a text header at the top of the board
+{{2da column| HeaderStrId |int| a [[string ID]] for a text header at the top of the board}}
-*ModuleRef - The campaign that owns this board
+{{2da column| ModuleRef |string| The campaign that owns this board}}
-*ShowDonationButton -
+{{2da column| ShowDonationButton |int| {{undocumented}} }}
-*DonationScript - script to be fired for each donation. Amount donated should be int param 0
+{{2da column| DonationScript |resource| script to be fired for each donation. Amount donated should be int param 0}}
-*DonationMsgStrId - String for the message box that is shown when the donation is accepted
+{{2da column| DonationMsgStrId |int| String for the message box that is shown when the donation is accepted}}
-!!Note: 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.!!
+'''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 ==
@@ Line 24: / Line 33: @@
 This second 2DA is responsible for placing entries on job boards.
-*ID - unique row ID number
+{{2da start}}
-*LABEL - a comment field
+{{2da column| LABEL | comment | }}
-*PlotRef - The plot resource that this particular entry belongs to
+{{2da column| PlotRef | resource| The plot resource that this particular entry belongs to}}
-*BoardId - This ID number corresponds to the board's row ID in the JobBoards 2DA.
+{{2da column| BoardId| int| This ID number corresponds to the board's row ID in the JobBoards 2DA.}}
-*VisibleFlag - 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| 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 - A flag ID number from the plot referenced in PlotRef. When the job is accepted by the player, this flag is set.
+{{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.}}
-*OfferID - Deprecated, no longer used
+{{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). }}
-*Comments
+{{2da column| 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.