Docks - Revision history

MarkGrant: /* "showNameTags" */

2020-11-03T17:20:22Z

‎"showNameTags"

2020-11-03T17:19:47Z

‎"acceptsQuestItems"

2020-11-03T17:19:36Z

‎"showCraftingKeyword"

2020-11-03T17:07:31Z

‎"nameTagOffset"

2020-11-03T16:56:27Z

‎"craftingKeyword"

2020-07-19T23:15:40Z

Removed renderOverride. It results in this error message - 'renderOverride' no longer supported on dockable

2020-06-30T07:27:50Z

‎"validDockables": lowercase "Sites" in example; correct minor typo

2018-02-08T12:53:05Z

Oops.

2018-02-08T12:52:03Z

Removed values that are no longer there.

2017-12-05T10:03:57Z

Updated to new section

← Older revision		Revision as of 17:20, 3 November 2020
Line 341:		Line 341:


−	This determines whether or not show the name ~~tag~~.	+	This determines whether or not show the name tags of docked tiles.

	== "processDrawables" ==		== "processDrawables" ==

← Older revision		Revision as of 17:19, 3 November 2020
Line 303:		Line 303:
	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''		'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''

−	'''Default Value:''' If not specified defaults to ~~Flase~~.	+	'''Default Value:''' If not specified defaults to False.

← Older revision		Revision as of 17:19, 3 November 2020
Line 298:		Line 298:

	This determines whether or not to display the [[#"craftingKeyword"]].		This determines whether or not to display the [[#"craftingKeyword"]].
		+
		+
		+	== "acceptsQuestItems" ==
		+	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''
		+
		+	'''Default Value:''' If not specified defaults to Flase.
		+
		+
		+	This determines whether or not quest items can be docked.

	== "effectSite" ==		== "effectSite" ==

← Older revision		Revision as of 17:07, 3 November 2020
Line 324:		Line 324:

	This is the additional offset of the name tag, from the centre of the block. This name tag displays what type of crafting is done by a station. This value is not useful on tiles that don't craft. Note that a distance of 1, is equal to a full tile.		This is the additional offset of the name tag, from the centre of the block. This name tag displays what type of crafting is done by a station. This value is not useful on tiles that don't craft. Note that a distance of 1, is equal to a full tile.
		+
		+
		+	== "showNameTags" ==
		+	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''
		+
		+	'''Default Value:''' If not specified defaults to True.
		+
		+
		+	This determines whether or not show the name tag.

	== "processDrawables" ==		== "processDrawables" ==

← Older revision		Revision as of 16:56, 3 November 2020
Line 290:		Line 290:
	A word to describe what is done at the crafting station. This is used to allow only certain crafts to work at this station. For example, the baking station has "bake" which will only allow [[Reactions]] that require "bake". Should be left empty for non-crafting objects.		A word to describe what is done at the crafting station. This is used to allow only certain crafts to work at this station. For example, the baking station has "bake" which will only allow [[Reactions]] that require "bake". Should be left empty for non-crafting objects.

		+
		+	== "showCraftingKeyword" ==
		+	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''
		+
		+	'''Default Value:''' If not specified defaults to True.
		+
		+
		+	This determines whether or not to display the [[#"craftingKeyword"]].

	== "effectSite" ==		== "effectSite" ==

@@ Line 568: / Line 568: @@
    "category" : "",
    "code" : "",
    "offset" : { "x" : 0.0, "y" : 0.0, "z" : 0.0},
    "rotation" : { "x" : 0.0, "y" : 0.0, "z" : 0.0},
@@ Line 644: / Line 643: @@
 This option specifies what group of sounds to play when an item is placed to this site.

@@ Line 563: / Line 563: @@
 Valid Dockables are a list of items that can be placed at each site. These items can either filter by a category or specify a code. There can then be extra properties that are used
-ValidDockables are made of a seperate blobs with their own properties. These properties are as follow;
+ValidDockables are made of a separate blobs with their own properties. These properties are as follow;
 <pre>
+{
@@ Line 575: / Line 575: @@
    "effect" : "",
    "unDockable" : true,
-   "Sites" : [ "a", "b" ],
+   "sites" : [ "a", "b" ],
    "group" : "base",
    "undockItem" : { "code" : "staxel.item.Null" }

← Older revision		Revision as of 12:53, 8 February 2018
Line 365:		Line 365:


−	Allows the dock site to not show Item Tags. Used more for docks that only want to show off items. --!>	+	Allows the dock site to not show Item Tags. Used more for docks that only want to show off items. -->

@@ Line 356: / Line 356: @@
-This option will specify if reagent are removed at the start (True) or the end of the craft (False). This is mainly used in cases where the item should stay avaliable until the end of the craft, such as when cakes are baking.
+This option will specify if reagent are removed at the start (True) or the end of the craft (False). This is mainly used in cases where the item should stay avaliable until the end of the craft, such as when cakes are baking.<!--
@@ Line 433: / Line 442: @@
 Stop the player from placing items into this site. Still allows items to be in the dock, from crafting, cooking etc.
@@ Line 549: / Line 549: @@
 This is the name of the site that will be used as the site to have all the results of any crafting. This must be included if this is a crafting tile.
@@ Line 579: / Line 588: @@
 This option specifies an Entity Action that will play when docking an item or player. This is commonly used to make a player sit in a chair or other similar actions.
@@ Line 617: / Line 617: @@
 This option specifies the trigger that will be applied to the object upon doing an action. Commonly "staxel.effect.DockItem".

@@ Line 694: / Line 694: @@
 === "undockItem" ===
-'''Valid options (Spawn Item): <code>See [[Items#Universal Spawning Rules]] for more information.</code>'''
+'''Valid options (Spawn Item): <code>See [[Items#How to Spawn an Item]] for more information.</code>'''
 '''Default Value:''' If not specified, will give back the normal item.
 This will be the item that is given when this dockable is undocked.