Lightning Component - Revision history

DeamonHunter: Update Page.

2017-12-14T10:12:10Z

Update Page.

DeamonHunter: /* Config Options */

2017-07-23T05:57:13Z

‎Config Options

DeamonHunter: Fix redlink.

2017-07-21T07:49:58Z

Fix redlink.

DeamonHunter: Initial commit.

2017-07-21T07:49:24Z

Initial commit.

New page

[[Category:Component Modding]]
[[: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 Lightning component, signified by the following;
<pre>
"lightning": {
=Content=
}
</pre>
Lightning components are used to add lightning to [[Weathers|Weather]]. In addition to adding lightning, this component allows you to customise the lightning to a degree.

= When and How to use =
Lightning component should be added to any weather that should have lightning added to it. Such as storms.

To start off with first, you will need to create a [[Weather]]. Once that is done, you can add the following below the last property of the file;
<pre>
"lightning": {
"baseDistance": 1000.0,
"baseDistanceSpread": 900.0,
"strikeInterval": 25.0,
"strikeIntervalSpread": 5.0,
"distantThunderSounds": [
"staxel.sounds.RollingThunder"
],
"nearThunderSounds": [
"staxel.sounds.NearThunder"
]
}
</pre>

"baseDistance" is how far away the lightning will spawn. "baseDistanceSpread" is how much additional random distance that is added or subtracted from the base distance. "strikeInterval" is how many seconds between lightning strikes. "strikeIntervalSpread" is how much additional random time that is added or subtracted from the base time. "distantThunderSounds" is a list of [[Sound|Sounds]] that will be used when the lightning is spawned more than 1000 units away. "nearThunderSounds" is a list of [[Sound|Sounds]] that will be used when the lightning is spawned less than 1000 units away.

With that, this component is complete.

= Config Options =
All config options must be inside the body of;
<pre>
"lightning": {
=Config Here=
}
</pre>

=== "baseDistance" ===
'''Valid options (Float): <code>A positive decimal number</code>'''

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

This is the base amount of distance the lightning will occur at.

=== "baseDistanceSpread" ===
'''Valid options (Float): <code>A positive decimal number</code>'''

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

This is the additional amount of random distance that is to be added or subtracted from base distance.

== "distantThunderSounds" ==
'''Valid options (List of Strings): <code>A list of strings each pointing to a [[Sound]] code.</code>'''

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

These are the lightning sounds that will be used when the lightning is greater than 1000 units away.

== "nearThunderSounds" ==
'''Valid options (List of Strings): <code>A list of strings each pointing to a [[Sound]] code.</code>'''

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

These are the lightning sounds that will be used when the lightning is lesser than 1000 units away.

=== "strikeInterval" ===
'''Valid options (Float): <code>A positive decimal number</code>'''

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

This is the amount of seconds between lightning strikes.

=== "strikeIntervalSpread" ===
'''Valid options (Float): <code>A positive decimal number</code>'''

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

This is the additional amount of random time that is to be added or subtracted from base time.

@@ Line 29: / Line 29: @@
 </pre>
-"baseDistance" is how far away the lightning will spawn. "baseDistanceSpread" is how much additional random distance that is added or subtracted from the base distance. "strikeInterval" is how many seconds between lightning strikes. "strikeIntervalSpread" is how much additional random time that is added or subtracted from the base time. "distantThunderSounds" is a list of [[Sound|Sounds]] that will be used when the lightning is spawned more than 1000 units away. "nearThunderSounds" is a list of [[Sound|Sounds]] that will be used when the lightning is spawned less than 1000 units away.
+[[#"baseDistance"]] is how far away the lightning will spawn. [[#"baseDistanceSpread"]] is how much additional random distance that is added or subtracted from the base distance. [[#"strikeInterval"]] is how many seconds between lightning strikes. [[#"strikeIntervalSpread"]] is how much additional random time that is added or subtracted from the base time. [[#"distantThunderSounds"]] is a list of [[Sound|Sounds]] that will be used when the lightning is spawned more than 1000 units away. [[#"nearThunderSounds"]] is a list of [[Sound|Sounds]] that will be used when the lightning is spawned less than 1000 units away.
 With that, this component is complete.
@@ Line 44: / Line 44: @@
 == "baseDistance" ==
-'''Valid options (Float): <code>A positive decimal number</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 53: / Line 53: @@
 == "baseDistanceSpread" ==
-'''Valid options (Float): <code>A positive decimal number</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 62: / Line 62: @@
 == "distantThunderSounds" ==
-'''Valid options (List of Strings): <code>A list of strings each pointing to a [[Sound]] code.</code>'''
+'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#String|Strings]]): <code>A list of strings each pointing to a [[Sound]] code.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 71: / Line 71: @@
 == "nearThunderSounds" ==
-'''Valid options (List of Strings): <code>A list of strings each pointing to a [[Sound]] code.</code>'''
+'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#String|Strings]]): <code>A list of strings each pointing to a [[Sound]] code.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 80: / Line 80: @@
 == "strikeInterval" ==
-'''Valid options (Float): <code>A positive decimal number</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 89: / Line 89: @@
 == "strikeIntervalSpread" ==
-'''Valid options (Float): <code>A positive decimal number</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.

@@ Line 8: / Line 8: @@
+}
 </pre>
-Lightning components are used to add lightning to [[Weathers|Weather]]. In addition to adding lightning, this component allows you to customise the lightning to a degree.
+Lightning components are used to add lightning to [[Weather]]. In addition to adding lightning, this component allows you to customise the lightning to a degree.
 = When and How to use =