Dialogue Pools - Revision history

DeamonHunter: Accidental mention of Villager Design due to copy pasting.

2018-02-02T11:55:03Z

Accidental mention of Villager Design due to copy pasting.

DeamonHunter: Formatting

2018-01-22T13:55:16Z

Formatting

DeamonHunter: Update tutorial.

2018-01-22T13:53:39Z

Update tutorial.

DeamonHunter: Updates.

2017-11-16T05:39:01Z

Updates.

DeamonHunter: /* "type" */ Formatting broke cause two spaces.

2017-11-16T05:37:45Z

‎"type": Formatting broke cause two spaces.

DeamonHunter: /* "type" */ Added missing types.

2017-11-16T05:37:14Z

‎"type": Added missing types.

DeamonHunter: Updated to new category.

2017-07-08T06:58:02Z

Updated to new category.

DeamonHunter: Correct Link

2017-06-13T12:36:23Z

Correct Link

DeamonHunter: Copy paste error

2017-06-13T12:35:49Z

Copy paste error

DeamonHunter: Removed copy-paste error from code. Clarified it more.

2017-06-13T12:09:45Z

Removed copy-paste error from code. Clarified it more.

@@ Line 21: / Line 21: @@
 First click on the button Asset Path and navigate upwards to the <code>/content/</code> folder. Once there, open the <code>/mods/</code> folder and create a new folder. Name this new folder to what you want the mod to be called and then open this new folder. When you open this folder give the asset a name, then click on the drop down and select ''<tt>Dialogue Pool Asset</tt>''. Then click save, give the item a code then click OK.
-After the asset is created, it will have been automatically selected. With that it is now time to tell the game what you want to do with this Villager Design. The following set of steps highlight the important properties, however you can mess with any property.
+After the asset is created, it will have been automatically selected. With that it is now time to tell the game what you want to do with this Dialogue Pool. The following set of steps highlight the important properties, however you can mess with any property.
 # Click on Dialogues. Click on the dropdown arrow. Find each individual dialogue you want, select them and click Add. Keep going until you have them all.

@@ Line 25: / Line 25: @@
 # Click on Dialogues. Click on the dropdown arrow. Find each individual dialogue you want, select them and click Add. Keep going until you have them all.
 # Click on Type of Dialogue. Select the one that is appropriate;
-** Personality: If you are creating this for one villager only, and it has nothing to do with a Job. Select this.
+#* Personality: If you are creating this for one villager only, and it has nothing to do with a Job. Select this.
-** Job: If you are creating this for one villager only, and it has has everything to do with a Job. Select this.
+#* Job: If you are creating this for one villager only, and it has has everything to do with a Job. Select this.
-** WorkPlaceMissing: If you are creating this for one villager only, and it has has everything to do with a not having a workplace. Select this.
+#* WorkPlaceMissing: If you are creating this for one villager only, and it has has everything to do with a not having a workplace. Select this.
-** Weather: If it's only about the weather. And you don't care who says this. Select this.
+#* Weather: If it's only about the weather. And you don't care who says this. Select this.
-** Morning: If it's meant to be at day. And you don't care who says this. Select this.
+#* Morning: If it's meant to be at day. And you don't care who says this. Select this.
-** Evening: If it's meant to be at night. And you don't care who says this. Select this.
+#* Evening: If it's meant to be at night. And you don't care who says this. Select this.
-** Theft: If it's meant to be about someone theiving. And you don't care who says this. Select this.
+#* Theft: If it's meant to be about someone theiving. And you don't care who says this. Select this.
-** Leaving: If it's meant to be about someone leaving. And you don't care who says this. Select this.
+#* Leaving: If it's meant to be about someone leaving. And you don't care who says this. Select this.
-** Quest: If it's meant to be a quest. Select this. (Quests require special actions using, [[Dialogue#Quest Functions]])
+#* Quest: If it's meant to be a quest. Select this. (Quests require special actions using, [[Dialogue#Quest Functions]])
-** Festival: If it's about a festival. And  you don't care who says this. Select this.
+#* Festival: If it's about a festival. And  you don't care who says this. Select this.
-** Seasonal: If it's about the season. And  you don't care who says this. Select this.
+#* Seasonal: If it's about the season. And  you don't care who says this. Select this.
-** TutorialNotCompleted: If it's about not having completed the tutorial yet. And you don't care who says this. Select this.
+#* TutorialNotCompleted: If it's about not having completed the tutorial yet. And you don't care who says this. Select this.
-** Unemployed: If it's about not having a job.QAnd you don't care who says this. Select this.
+#* Unemployed: If it's about not having a job.QAnd you don't care who says this. Select this.
-** General: If you don't care who says this. Select this.
+#* General: If you don't care who says this. Select this.
 In most cases you will want "Personality" or "Job".

@@ Line 2: / Line 2: @@
 In Staxel, *.dialoguepool files are used to specify a collection of dialogues which are to be played together. These files also contain a type property to describe what type of dialogues are collected.
-= Creating a *.dialoguepool file =
+= Creating New Dialogue Pools =
-Creating an dialogue pool is fairly easy once you have created a dialogue, due to dialogue pools being more of a collection of other files. The full file looks like;
+''Before you start this tutorial, be sure to head through [[Modding#Getting Started with Staxel Modding]].''
 <pre>
+{
@@ Line 10: / Line 59: @@
    "type" : "Personality",
    "dialogue" : [
-     "mods.modname.dialogue.dialoguename"
+     "mods.modname.dialogue.dialoguename",
+   ]
+}
 </pre>
-The property "type" can only contain special values, [[#"type"|listed below]]. Otherwise the rest should be explanatory. Once this is done, you can add it to your [[Villager Personalities]]
+With the file being this short, there is no need for pictures. Here is the explanation of the two properties.
@@ Line 36: / Line 98: @@
 == "type" ==
-'''Valid options ([[Modding_Key_Terms#String|String]]): <code>One of the following options: Greeting, General, Weather, Evening, Morning, Personality, Quest, Theft, Leaving, Job, WorkPlaceMissing, Unemployed, Unique, Festival, TutorialNotCompleted, Seasonal</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>One of the options specified below.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 42: / Line 104: @@
 This string chooses the type of dialogue and how the game should handle it. Some sections will require a certain type of dialogue or will crash.

@@ Line 20: / Line 20: @@
 = Config Options =
 == "code" ==
-'''Valid options (String): <code>A unique string which dialogue pool this object is.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A unique string which dialogue pool this object is.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 28: / Line 28: @@
 == "dialogue" ==
-'''Valid options (List of strings): <code>A list of strings which point to a [[Dialogue]] code each.</code>'''
+'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#String|Strings]]): <code>A list of strings which point to a [[Dialogue]] code each.</code>'''
-'''Default Value:''' Null or nothing specified.
+'''Default Value:''' If not specified, no dialogues will get added to this pool.
@@ Line 36: / Line 36: @@
 == "type" ==
-'''Valid options (String): <code>One of the following options: Greeting, General, Weather, Evening, Morning, Personality, Quest, Theft, Leaving, Job, WorkPlaceMissing, Unemployed, Unique, Festival, TutorialNotCompleted, Seasonal</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>One of the following options: Greeting, General, Weather, Evening, Morning, Personality, Quest, Theft, Leaving, Job, WorkPlaceMissing, Unemployed, Unique, Festival, TutorialNotCompleted, Seasonal</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.

@@ Line 36: / Line 36: @@
 == "type" ==
-'''Valid options (String): <code>One of the following options: Greeting, General, Weather, Evening, Morning, Personality, Quest, Theft, Leaving, Job, WorkPlaceMissing, Unemployed, Unique, Festival, TutorialNotCompleted,
+'''Valid options (String): <code>One of the following options: Greeting, General, Weather, Evening, Morning, Personality, Quest, Theft, Leaving, Job, WorkPlaceMissing, Unemployed, Unique, Festival, TutorialNotCompleted, Seasonal</code>'''
- Seasonal</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.

← Older revision		Revision as of 06:58, 8 July 2017
Line 1:		Line 1:
−	[[Category:Modding]] [[Category:~~VillagerModding~~]]	+	[[Category:Modding]] [[Category:Villager Modding]]
	In Staxel, *.dialoguepool files are used to specify a collection of dialogues which are to be played together. These files also contain a type property to describe what type of dialogues are collected.		In Staxel, *.dialoguepool files are used to specify a collection of dialogues which are to be played together. These files also contain a type property to describe what type of dialogues are collected.