Difference between revisions of "Frame Animated Tile Component"

From wiki
Jump to: navigation, search
(Initial commit.)
 
(Update Page.)
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
[[: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.
 
[[: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 Frame Animated Tile component, signified by the following;
+
On this page, we go over the Frame Animated Tile Component, signified by the following;
 
<pre>
 
<pre>
 
"frameAnimatedTile": {
 
"frameAnimatedTile": {
Line 8: Line 8:
 
}
 
}
 
</pre>
 
</pre>
Frame Animated Tile components are used to defined how often a Frame Animated Tile will change it's look.
+
Frame Animated Tile Components are used to defined how often a Frame Animated Tile will change it's look.
  
 
= When and How to use =
 
= When and How to use =
Frame Animated Tile component is needed whenever you want to make an Frame Animatedtile. Specifically, an Frame Animated Tile component is needed whenever a [[Tile]] has it [[Tile#"tileStateKind"]] equal to "staxel.tileState.FrameAnimated". Otherwise Frame Animated Tile component will do nothing.
+
Frame Animated Tile Component is needed whenever you want to make an Frame Animatedtile. Specifically, an Frame Animated Tile Component is needed whenever a [[Tile]] has it [[Tile#"tileStateKind"]] equal to "staxel.tileState.FrameAnimated". Otherwise Frame Animated Tile component will do nothing.
  
 
This section will be elaborated later when Frame Animated Tiles are explained in more detail.
 
This section will be elaborated later when Frame Animated Tiles are explained in more detail.
Line 25: Line 25:
  
 
== "frameTime" ==
 
== "frameTime" ==
'''Valid options (Float): <code>A positive decimal number</code>'''
+
'''Valid options ([[Modding_Key_Terms#String|Float]]): <code>A positive decimal number</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.
Line 31: Line 31:
  
 
This is the time in seconds before the object will change it's look.
 
This is the time in seconds before the object will change it's look.
 +
 +
== "particles" ==
 +
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the code to a [[Particles|Particle]] spawner.</code>'''
 +
 +
'''Default Value:''' If not specified, will not play particles.
 +
 +
 +
This is the particles that will play constantly along with the animation.

Latest revision as of 05:56, 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 Frame Animated Tile Component, signified by the following;

"frameAnimatedTile": {
  "frameTime" : 0.1
}

Frame Animated Tile Components are used to defined how often a Frame Animated Tile will change it's look.

When and How to use

Frame Animated Tile Component is needed whenever you want to make an Frame Animatedtile. Specifically, an Frame Animated Tile Component is needed whenever a Tile has it Tile#"tileStateKind" equal to "staxel.tileState.FrameAnimated". Otherwise Frame Animated Tile component will do nothing.

This section will be elaborated later when Frame Animated Tiles are explained in more detail.


Config Options

All config options must be inside the body of;

"frameAnimatedTile": {
  =Content=
}

"frameTime"

Valid options (Float): A positive decimal number

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


This is the time in seconds before the object will change it's look.

"particles"

Valid options (String): A string containing the code to a Particle spawner.

Default Value: If not specified, will not play particles.


This is the particles that will play constantly along with the animation.