Difference between revisions of "Totem Component"

From wiki
Jump to: navigation, search
(Initial commit.)
 
(Update Page.)
 
(One intermediate revision by the same user not shown)
Line 21: Line 21:
 
</pre>
 
</pre>
  
The only property is "code". This is used to specify a [[Totem]] file that is to be used.
+
The only property is [[#"code"]]. This is used to specify a [[Totems|Totem]] file that is to be used.
 
+
  
 
= Config Options =
 
= Config Options =
Line 33: Line 32:
  
 
== "code" ==
 
== "code" ==
'''Valid options (String): <code>A string which points to a [[Totems|Totem]] code.</code>'''
+
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string which points to a [[Totems|Totem]] code.</code>'''
  
 
'''Default Value:''' No default value is specified. Always need to provide your own.
 
'''Default Value:''' No default value is specified. Always need to provide your own.

Latest revision as of 06:15, 14 December 2017

Category:Component Modding are all optional properties that can be added to any file. Components are useful in extending the original files with even more information, such as the cost of the item or whether the block can be broken by a weapon.

On this page, we go over the Totem component, signified by the following;

"totem": { 
  "code": "staxel.totem.whatever"
}

Totem components are used to activate Totems in the world. This is a fairly simple component that is used on a Tile.


When and How to use

Totem components should be used on any tile that you would want to be a totem. This component can only be specifically used by Tiles with a Tile#"tileStateKind" equal to "staxel.tileState.Totem".

To create this component you would use the following;

"totem": { 
  "code": "staxel.totem.whatever"
}

The only property is #"code". This is used to specify a Totem file that is to be used.

Config Options

All config options must be inside the body of;

"totem": {
  =Config Here=
}

"code"

Valid options (String): A string which points to a Totem code.

Default Value: No default value is specified. Always need to provide your own.


This is the Totem that is to be used on this tile.