Latest revision as of 06:45, 7 February 2018

In Staxel, *.particle files are used to specify a particle spawner. These particle spawners have several properties;

Location and Size
Speed and size of spawned particles
Colour and gravity of particles

Along with more options.

Creating a *.particle file

Creating an effect is fairly easy, though will take work in order to get the particle correct. The following is a file which implements all the options of a particle spawner.

{
  "code" : "mods.yourmodname.particlefilename",
  "angularVelocity" : 0.0,
  "liveDuration" : 1.5,
  "particlesPerSecond" : 120.0,
  "scale" : 0.5,
  "scaleSpread" : 0.0,
  "emitDuration" : 0.0,
  "color" : "ff023CCB",
  "colorSpread" : {"x" : 0.05, "y" : 0.05, "z" : 0.05},
  "emitVelocity" : {"x" : 0.0, "y" : 6.7,  "z" : 0.0},  
  "emitVelocitySpread" : {"x" : 4.5, "y" : 2.5, "z" : 4.5},
  "gravityFactor" : {"x" : 0.0, "y" : -0.25, "z" : 0.0},
  "position" : {"x" : 0.0, "y" : -0.125, "z" : 0.0},
  "positionSpread" : {"x" : 0.5, "y" : 0.05, "z" : 0.5}
}

Once you have created a file like that, you can then specify the code for other files which can play particles, such as Effect files. For info on what each option actually does, look below at #Config Options.

Config Options

"code"

Valid options (String): A unique string which Particle System this object is.

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

A string containing the code of the Particles the blob will be referring to.

"angularVelocity"

Valid options (Float): A positive decimal number.

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

This number affects the amount of angular velocity, or the spin, of each particle that is spawned.

"color"

Valid options (Colour): A string of 6 (RRGGBB) or 8 (AARRGGBB) characters represent the hex code of a colour e.g. ABC123 or AABBCCDD.

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

This is the colour of which all particles are spawned with. This takes affect before colour spread.

"colorSpread"

Valid options (Vector 3 - Float): {"x": 0.0, "y": 0.0, "z": 0.0}

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

This specifies how much the colour should vary. In this case "x" represents the change in Red, "y" Green and "z" Blue. These values are between 0 and 1, 0 being no change in colour, and 1 being able to change to any value.

"emissive"

Valid options (Float): A positive decimal number.

Default Value: If not specified, will default to 0.0.

This specifies how much light each particle will give off.

"emitDuration"

Valid options (Float): A positive decimal number.

Default Value: If not specified, will default to 0.0.

This specifies how long a particle source will continue to spawn particles. After the amount of seconds has passed, no new particles can spawn. If left as 0, then the particles will continue on infinitely, as long as the thing causing the particles stays in the world.

"emitVelocity"

Valid options (Vector 3 - Float): {"x": 0.0, "y": 0.0, "z": 0.0}

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

This specifies the initial speed of the velocity along the three axis. Applied before "emitVelocitySpread".

"emitVelocitySpread"

Valid options (Vector 3 - Float): {"x": 0.0, "y": 0.0, "z": 0.0}

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

This specifies the maximum amount of speed that can be randomly subtracted or added to the initial velocity of the particle when spawned.

"gravityFactor"

Valid options (Vector 3 - Float): {"x": 0.0, "y": 0.0, "z": 0.0}

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

This specifies the speed at which the particle will change during the time it is alive. For example, a value of "y": 1.0 will make the particle fall downwards.

"insideOpasity"

Valid options (Float): A positive decimal number.

Default Value: If not specified, will default to 1.0.

This specifies how opaque a particle will be, with 0 being invisible and 1 being fully visible.

"liveDuration"

Valid options (Float): A positive decimal number.

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

This specifies how long a particle will stay "alive". After the amount of seconds specified, the particle will be destroyed. Should be set to a low value in order to avoid players having too many particles to render.

"particlesPerSecond"

Valid options (Float): A positive decimal number.

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

This specifies how many separate particles will be spawned per second. It can be though of spawning a particle every 1/xth of a second.

"position"

Valid options (Vector 3 - Float): {"x": 0.0, "y": 0.0, "z": 0.0}

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

This specifies the initial offset of the particle to the tile. Often placing all values to 0.5 will place in the centre of a tile. Though this will change depending on use.

"positionRotation"

Valid options (Float): A positive decimal number.

Default Value: If not specified, will default to 0.0.

This specifies how much a particle will be rotated around when spawned.

"positionSpread"

Valid options (Vector 3 - Float): {"x": 0.0, "y": 0.0, "z": 0.0}

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

This specifies the maximum distance away from the offset the the particle can spawn. For example have a value of "y" : 1 means that a particle can spawn up to 1 tile higher or lower than the actual offset.

"scale"

Valid options (Float): A positive decimal number.

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

This specifies scaled size of the spawned particle.

"scaleSpread"

Valid options (Float): A positive decimal number.

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

An additional multiplier that specifies scaled the maximum amount of variance in size. Particles can grow or shrink up to this value.

"velocityStretch"

Valid options (Float): A positive decimal number.

Default Value: If not specified, will default to 0.0.

This specifies how much a particle will stretch because of it's speed.

@@ Line 9: / Line 9: @@
-= Creating a *.effect file =
+= Creating a *.particle file =
 Creating an effect is fairly easy, though will take work in order to get the particle correct. The following is a file which implements all the options of a particle spawner.
@@ Line 36: / Line 36: @@
 = Config Options =
 == "code" ==
-'''Valid options (String): <code>Any valid string that leads to an item.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A unique string which Particle System this object is.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
-A string containing the code of the item the blob will be referring to.
+A string containing the code of the Particles the blob will be referring to.
 == "angularVelocity" ==
-'''Valid options (float): <code>A decimal number representing speed.</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 51: / Line 51: @@
 This number affects the amount of angular velocity, or the spin, of each particle that is spawned.
 == "color" ==
-'''Valid options (Strings): <code>A string of 6 or 8 characters represent the hex code of a colour e.g. #ABC123</code>'''
+'''Valid options ([[Modding_Key_Terms#Colour|Colour]]): <code>A string of 6 (RRGGBB) or 8 (AARRGGBB) characters represent the hex code of a colour e.g. ABC123 or AABBCCDD.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 62: / Line 63: @@
 == "colorSpread" ==
-'''Valid options (Vector3): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Float|Float]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 68: / Line 69: @@
 This specifies how much the colour should vary. In this case "x" represents the change in Red, "y" Green and "z" Blue. These values are between 0 and 1, 0 being no change in colour, and 1 being able to change to any value.
+== "emissive" ==
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
+'''Default Value:''' If not specified, will default to 0.0.
+This specifies how much light each particle will give off.
+== "emitDuration" ==
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
+'''Default Value:''' If not specified, will default to 0.0.
+This specifies how long a particle source will continue to spawn particles. After the amount of seconds has passed, no new particles can spawn. If left as 0, then the particles will continue on infinitely, as long as the thing causing the particles stays in the world.
 == "emitVelocity" ==
-'''Valid options (Vector3): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Float|Float]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 79: / Line 99: @@
 == "emitVelocitySpread" ==
-'''Valid options (Vector3): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Float|Float]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 88: / Line 108: @@
 == "gravityFactor" ==
-'''Valid options (Vector3): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Float|Float]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 94: / Line 114: @@
 This specifies the speed at which the particle will change during the time it is alive. For example, a value of "y": 1.0 will make the particle fall downwards.
+== "insideOpasity" ==
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
+'''Default Value:''' If not specified, will default to 1.0.
+This specifies how opaque a particle will be, with 0 being invisible and 1 being fully visible.
 == "liveDuration" ==
-'''Valid options (Float): <code>A decimal number representing seconds</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 106: / Line 135: @@
 == "particlesPerSecond" ==
-'''Valid options (Float): <code>A decimal number representing seconds</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 115: / Line 144: @@
 == "position" ==
-'''Valid options (Vector3): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Float|Float]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 121: / Line 150: @@
 This specifies the initial offset of the particle to the tile. Often placing all values to 0.5 will place in the centre of a tile. Though this will change depending on use.
+== "positionRotation" ==
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
+'''Default Value:''' If not specified, will default to 0.0.
+This specifies how much a particle will be rotated around when spawned.
 == "positionSpread" ==
-'''Valid options (Vector3): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Float|Float]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 133: / Line 171: @@
 == "scale" ==
-'''Valid options (float): <code>A number specifying size</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 142: / Line 180: @@
 == "scaleSpread" ==
-'''Valid options (float): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</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 148: / Line 186: @@
 An additional multiplier that specifies scaled the maximum amount of variance in size. Particles can grow or shrink up to this value.
-== "emitDuration" ==
-'''Valid options (Float): <code>A decimal number representing seconds</code>'''
-'''Default Value:''' 0.0 (Continue Infinitely)
-This specifies how long a particle source will continue to spawn particles. After the amount of seconds has passed, no new particles can spawn. If left as 0, then the particles will continue on infinitely, as long as the thing causing the particles stays in the world.
-== "emitDuration" ==
-'''Valid options (Float): <code>A decimal number between 0 and 1</code>'''
-'''Default Value:''' 1.0 (Not transparent)
-This specifies how opaque a particle will be, with 0 being invisible and 1 being fully visible.
 == "velocityStretch" ==
-'''Valid options (Float): <code>A decimal number</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
-'''Default Value:''' 0.0 (No stretch)
+'''Default Value:''' If not specified, will default to 0.0.
 This specifies how much a particle will stretch because of it's speed.
-== "positionRotation" ==
-'''Valid options (Float): <code>A decimal number</code>'''
-'''Default Value:''' 0.0 (No rotation)
-This specifies how much a particle will be rotated around when spawned.

Difference between revisions of "Particles"

Latest revision as of 06:45, 7 February 2018

Contents

Creating a *.particle file

Config Options

"code"

"angularVelocity"

"color"

"colorSpread"

"emissive"

"emitDuration"

"emitVelocity"

"emitVelocitySpread"

"gravityFactor"

"insideOpasity"

"liveDuration"

"particlesPerSecond"

"position"

"positionRotation"

"positionSpread"

"scale"

"scaleSpread"

"velocityStretch"

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools