Spring - User contributions [en]

Simpleparticlesystem

2006-11-06T05:00:54Z

Yeha:

'''Propertiers for SimpleParticleSystem:'''

<ul>

<li>
'''float3 pos''' 
Position of the particle system emmiter.
</li> 

<li>
'''[[AtlasedTexture]] texture''' 
Texture for the particles.
</li> 

<li>
'''float3 emitVector''' 
Vector that describes the direction of the particles, this is then modified by the rotation propertiers.
</li> 

<li>
'''[[CColorMap]] colorMap''' 
Colormap describing the colors of the particles during their lifetime.
</li> 

<li>
'''float3 gravity''' 
Vector force applied to the particles every frame.
</li> 

<li>
'''float airdrag''' 
Constant multiplier on the particle each frame, a value of 1.0 means the particles will keep their current momentum, a value bellow 1 and they will slow down each frame.
</li> 

<li>
'''float particleLife''' 
Life of the particles in frames.
</li> 

<li>
'''float particleLifeSpread''' 
Random number between 0 and particleLifeSpread added to particleLife.
</li> 

<li>
'''int numParticles''' 
Number of particles that will be spawned.
</li> 

<li>
'''float particleSpeed''' 
Initial speed of the particles.
</li> 

<li>
'''float particleSpeedSpread''' 
Random number between 0 and particleSpeedSpread added to particleSpeed.
</li> 

<li>
'''float particleSize''' 
Size of the particles.
</li> 

<li>
'''float particleSizeSpread''' 
Random number between 0 and particleSizeSpread added to particleSize.
</li> 

<li>
'''float sizeGrowth''' 
Size added to particles each frame.
</li> 

<li>
'''float sizeMod''' 
Size frame multiplier.
</li> 

<li>
'''float emitRot''' 
Rotation in degree from emitVector that particles will be spawned from, a value of 90 will emmit particles in a plane perpendicular to the emitVector.
</li> 

<li>
'''float emitRotSpread''' 
Random number between 0 and emitRotSpread added to emitRot, a value of 180 will make the particles spawn in a full sphere.
</li> 

<li>
'''bool directional''' 
If the particles should be oriented to point at the direction of their velocity.
</li> 

</ul>

Simpleparticlesystem

2006-11-06T05:00:31Z

Yeha:

Simpleparticlesystem

2006-10-31T17:57:05Z

Yeha:

'''Propertiers for SimpleParticleSystem:'''

<ul>
<li>
'''[[AtlasedTexture]] texture''' 
Texture for the particles.
</li> 

<li>
'''float3 emitVector''' 
Vector that describes the direction of the particles, this is then modified by the rotation propertiers.
</li> 

<li>
'''[[CColorMap]] colorMap''' 
Colormap describing the colors of the particles during their lifetime.
</li> 

<li>
'''float3 gravity''' 
Vector force applied to the particles every frame.
</li> 

<li>
'''float airdrag''' 
Constant multiplier on the particle each frame, a value of 1.0 means the particles will keep their current momentum, a value bellow 1 and they will slow down each frame.
</li> 

<li>
'''float particleLife''' 
Life of the particles in frames.
</li> 

<li>
'''float particleLifeSpread''' 
Random number between 0 and particleLifeSpread added to particleLife.
</li> 

<li>
'''int numParticles''' 
Number of particles that will be spawned.
</li> 

<li>
'''float particleSpeed''' 
Initial speed of the particles.
</li> 

<li>
'''float particleSpeedSpread''' 
Random number between 0 and particleSpeedSpread added to particleSpeed.
</li> 

<li>
'''float particleSize''' 
Size of the particles.
</li> 

<li>
'''float particleSizeSpread''' 
Random number between 0 and particleSizeSpread added to particleSize.
</li> 

<li>
'''float emitRot''' 
Rotation in degree from emitVector that particles will be spawned from, a value of 90 will emmit particles in a plane perpendicular to the emitVector.
</li> 

<li>
'''float emitRotSpread''' 
Random number between 0 and emitRotSpread added to emitRot, a value of 180 will make the particles spawn in a full sphere.
</li> 

<li>
'''bool directional''' 
If the particles should be oriented to point at the direction of their velocity.
</li> 

</ul>

Simpleparticlesystem

2006-10-31T17:51:20Z

Yeha:

CEG-OldInfo

2006-10-31T17:36:07Z

Yeha: /* Projectile classes usable in explosion generators */

== Custom explosion generators ==

=== What are they? ===
Custom explosions are small explosion scripts read from gamedata/explosions/*.tdf.
The explosion script specifies which particles/projectiles have to be created when the explosion happens, and their initial properties (position,speed,...)

=== Explosion script definition ===

The explosion script directly specifies which C++ projectile classes have to be created, and also which properties the projectiles should have.

The explosion script is structured like this:

[ExplosionScriptName]
{
[projectile scriptname] // this specifies the class of the projectile
{
[properties]
{
size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60; // These codes are explained below
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
underwater=0; // should this projectile be created when underwater?
air=0; // should this projectile be created when in air?
water=1; // should this projectile be created on water?
ground=1; // should this projectile be created when on ground?
count=10; // number of projectiles of this type
}
.. other projectiles types can follow here ..
}

Defaults for air/underwater/ground/water are zero.
Default of count is 1.

=== Projectile properties ===

To begin, you should run
spring /p (or "spring -p" on linux)
to let spring export "projectiles.txt", which contains all the classes you can use in an explosion script. At the time of writing, this would contain [[projectiles.txt]]

The items listed in "properties" are directly mapped to the class properties in projectiles.txt
The properties are specified with a bit of a cryptic syntax. You can use extra commands in them (r,d,i). For example this:

pos = -30 r60, r30, -30 r60;

The x coordinate (specified with -30 r60) will be:
x = -30 + (Random value between 0 and 60);

Commands:
rX: add a number between 0 and X
iX: multiply the projectile index with X and add it. See the example for this below.
dX: multiply the damage with X and add it.

== Explosion script examples ==

This is an example of a script that makes 10 smoke projectiles (yeah they should have been called particles, but they are handled by spring using the projectile system)

[ARM_HLT_Expl]
{
[smoke]
{
[properties]
{
// age increase per frame, when age >= 1 the particle is destroyed
ageSpeed=0.04;

size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60;
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
water=1;
ground=1;
count=10;
}
}

This particular script would be linked to with "explosiongenerator=custom:ARM_HLT_Expl;"

Here is an example that uses the index (i) command in the properties:

[heatcloud]
{
[properties]
{
pos = 0, i20, 0;
heat = 10;
maxheat=10;
heatFalloff=1;
size = 30;
}
ground=1;
count=10;
}

This script creates a tower of heatcloud projectile. The first projectile gets y=0, the second y=20, y=40, y=60, .. and finally y=180

=== How to link a custom explosion to a weapon ===

The weapon definitions needs to have this in it:
explosiongenerator = custom:ExplosionScriptName;

The explosion definition for ExplosionScriptName would be one of the TDF files in gamedata/explosions/

You can also link the weapons for self-destruct and normal destruct to an explosion script.

=== Adding ground flashes ===

The ground flash is currently not an actual projectile, so it's specified in a different way:
[ARM_HLT_Expl]
{
.. projectiles definitions ..

[groundflash]
{
flashSize = 100; // flash size
flashAlpha = 1; // initial alpha of the flash
circleGrowth = 60; // size increase/frame
circleAlpha = 1; // initial alpha of the ring
ttl = 10; // number of frames
color = 0,0,1; // color RGB
}
}

== Projectile classes usable in explosion generators ==
[[dirt]] 
[[heatcloud]] 
[[smoke]] 
[[smoke2]] 
[[gfx]] 
[[bitmapmuzzleflame]] 
[[simpleparticlesystem]] 

== Keywords ==
These are keywords that can be used in the explosiongenerator script to give a propertier a special value.

<ul>

<li>
'''dir''' 
This can only be used on a float3 vector. This will be the direction vector if the event that created this explosiongenerator can be described with a direction.
For weapon impacts, its the direction of the impact (the travel direction of the projectile when it explodes). For script emmited explosiongenerators it is the direction of the piece that emmits it.
</li>

</ul>

CColorMap

2006-09-30T00:06:45Z

Yeha:

A ColorMap is a collection of 2 or more number of RGBA colors. They can be expressed either as a string of numbers, or pointing to an image file where each pixel will be used as a color.

Example:

This gives a colormap with 2 colors, first one blue and second one white: 
<code>colormap=1 0 0 0 1 1 1 0</code>

Or it can be pointed to a bitmap file: 
<code>colormap=bitmap_file.tga</code>

Colormaps usually describes how the colors of an entity will shift during its lifetime, where the first color will be used at the beginning and then cycle through all colors untill the last one is use at the end of its lifetime.

CEG-OldInfo

2006-09-30T00:03:43Z

Yeha: /* Keywords */

== Custom explosion generators ==

=== What are they? ===
Custom explosions are small explosion scripts read from gamedata/explosions/*.tdf.
The explosion script specifies which particles/projectiles have to be created when the explosion happens, and their initial properties (position,speed,...)

=== Explosion script definition ===

The explosion script directly specifies which C++ projectile classes have to be created, and also which properties the projectiles should have.

The explosion script is structured like this:

[ExplosionScriptName]
{
[projectile scriptname] // this specifies the class of the projectile
{
[properties]
{
size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60; // These codes are explained below
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
underwater=0; // should this projectile be created when underwater?
air=0; // should this projectile be created when in air?
water=1; // should this projectile be created on water?
ground=1; // should this projectile be created when on ground?
count=10; // number of projectiles of this type
}
.. other projectiles types can follow here ..
}

Defaults for air/underwater/ground/water are zero.
Default of count is 1.

=== Projectile properties ===

To begin, you should run
spring /p (or "spring -p" on linux)
to let spring export "projectiles.txt", which contains all the classes you can use in an explosion script. At the time of writing, this would contain [[projectiles.txt]]

The items listed in "properties" are directly mapped to the class properties in projectiles.txt
The properties are specified with a bit of a cryptic syntax. You can use extra commands in them (r,d,i). For example this:

pos = -30 r60, r30, -30 r60;

The x coordinate (specified with -30 r60) will be:
x = -30 + (Random value between 0 and 60);

Commands:
rX: add a number between 0 and X
iX: multiply the projectile index with X and add it. See the example for this below.
dX: multiply the damage with X and add it.

== Explosion script examples ==

This is an example of a script that makes 10 smoke projectiles (yeah they should have been called particles, but they are handled by spring using the projectile system)

[ARM_HLT_Expl]
{
[smoke]
{
[properties]
{
// age increase per frame, when age >= 1 the particle is destroyed
ageSpeed=0.04;

size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60;
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
water=1;
ground=1;
count=10;
}
}

This particular script would be linked to with "explosiongenerator=custom:ARM_HLT_Expl;"

Here is an example that uses the index (i) command in the properties:

[heatcloud]
{
[properties]
{
pos = 0, i20, 0;
heat = 10;
maxheat=10;
heatFalloff=1;
size = 30;
}
ground=1;
count=10;
}

This script creates a tower of heatcloud projectile. The first projectile gets y=0, the second y=20, y=40, y=60, .. and finally y=180

=== How to link a custom explosion to a weapon ===

The weapon definitions needs to have this in it:
explosiongenerator = custom:ExplosionScriptName;

The explosion definition for ExplosionScriptName would be one of the TDF files in gamedata/explosions/

You can also link the weapons for self-destruct and normal destruct to an explosion script.

=== Adding ground flashes ===

The ground flash is currently not an actual projectile, so it's specified in a different way:
[ARM_HLT_Expl]
{
.. projectiles definitions ..

[groundflash]
{
flashSize = 100; // flash size
flashAlpha = 1; // initial alpha of the flash
circleGrowth = 60; // size increase/frame
circleAlpha = 1; // initial alpha of the ring
ttl = 10; // number of frames
color = 0,0,1; // color RGB
}
}

== Projectile classes usable in explosion generators ==
[[dirt]] 
[[heatcloud]] 
[[smoke]] 
[[smoke2]] 
[[gfx]] 
[[bitmapmuzzleflame]] 

== Keywords ==
These are keywords that can be used in the explosiongenerator script to give a propertier a special value.

<ul>

<li>
'''dir''' 
This can only be used on a float3 vector. This will be the direction vector if the event that created this explosiongenerator can be described with a direction.
For weapon impacts, its the direction of the impact (the travel direction of the projectile when it explodes). For script emmited explosiongenerators it is the direction of the piece that emmits it.
</li>

</ul>

CEG-OldInfo

2006-09-30T00:03:32Z

Yeha: /* Keywords */

== Custom explosion generators ==

=== What are they? ===
Custom explosions are small explosion scripts read from gamedata/explosions/*.tdf.
The explosion script specifies which particles/projectiles have to be created when the explosion happens, and their initial properties (position,speed,...)

=== Explosion script definition ===

The explosion script directly specifies which C++ projectile classes have to be created, and also which properties the projectiles should have.

The explosion script is structured like this:

[ExplosionScriptName]
{
[projectile scriptname] // this specifies the class of the projectile
{
[properties]
{
size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60; // These codes are explained below
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
underwater=0; // should this projectile be created when underwater?
air=0; // should this projectile be created when in air?
water=1; // should this projectile be created on water?
ground=1; // should this projectile be created when on ground?
count=10; // number of projectiles of this type
}
.. other projectiles types can follow here ..
}

Defaults for air/underwater/ground/water are zero.
Default of count is 1.

=== Projectile properties ===

To begin, you should run
spring /p (or "spring -p" on linux)
to let spring export "projectiles.txt", which contains all the classes you can use in an explosion script. At the time of writing, this would contain [[projectiles.txt]]

The items listed in "properties" are directly mapped to the class properties in projectiles.txt
The properties are specified with a bit of a cryptic syntax. You can use extra commands in them (r,d,i). For example this:

pos = -30 r60, r30, -30 r60;

The x coordinate (specified with -30 r60) will be:
x = -30 + (Random value between 0 and 60);

Commands:
rX: add a number between 0 and X
iX: multiply the projectile index with X and add it. See the example for this below.
dX: multiply the damage with X and add it.

== Explosion script examples ==

This is an example of a script that makes 10 smoke projectiles (yeah they should have been called particles, but they are handled by spring using the projectile system)

[ARM_HLT_Expl]
{
[smoke]
{
[properties]
{
// age increase per frame, when age >= 1 the particle is destroyed
ageSpeed=0.04;

size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60;
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
water=1;
ground=1;
count=10;
}
}

This particular script would be linked to with "explosiongenerator=custom:ARM_HLT_Expl;"

Here is an example that uses the index (i) command in the properties:

[heatcloud]
{
[properties]
{
pos = 0, i20, 0;
heat = 10;
maxheat=10;
heatFalloff=1;
size = 30;
}
ground=1;
count=10;
}

This script creates a tower of heatcloud projectile. The first projectile gets y=0, the second y=20, y=40, y=60, .. and finally y=180

=== How to link a custom explosion to a weapon ===

The weapon definitions needs to have this in it:
explosiongenerator = custom:ExplosionScriptName;

The explosion definition for ExplosionScriptName would be one of the TDF files in gamedata/explosions/

You can also link the weapons for self-destruct and normal destruct to an explosion script.

=== Adding ground flashes ===

The ground flash is currently not an actual projectile, so it's specified in a different way:
[ARM_HLT_Expl]
{
.. projectiles definitions ..

[groundflash]
{
flashSize = 100; // flash size
flashAlpha = 1; // initial alpha of the flash
circleGrowth = 60; // size increase/frame
circleAlpha = 1; // initial alpha of the ring
ttl = 10; // number of frames
color = 0,0,1; // color RGB
}
}

== Projectile classes usable in explosion generators ==
[[dirt]] 
[[heatcloud]] 
[[smoke]] 
[[smoke2]] 
[[gfx]] 
[[bitmapmuzzleflame]] 

== Keywords ==
These are keywords that can be used in the explosiongenerator script to give a propertier a special value.

<ul>

<li>
'''dir'''
This can only be used on a float3 vector. This will be the direction vector if the event that created this explosiongenerator can be described with a direction.
For weapon impacts, its the direction of the impact (the travel direction of the projectile when it explodes). For script emmited explosiongenerators it is the direction of the piece that emmits it.
</li>

</ul>

CEG-OldInfo

2006-09-29T23:58:11Z

Yeha:

== Custom explosion generators ==

=== What are they? ===
Custom explosions are small explosion scripts read from gamedata/explosions/*.tdf.
The explosion script specifies which particles/projectiles have to be created when the explosion happens, and their initial properties (position,speed,...)

=== Explosion script definition ===

The explosion script directly specifies which C++ projectile classes have to be created, and also which properties the projectiles should have.

The explosion script is structured like this:

[ExplosionScriptName]
{
[projectile scriptname] // this specifies the class of the projectile
{
[properties]
{
size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60; // These codes are explained below
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
underwater=0; // should this projectile be created when underwater?
air=0; // should this projectile be created when in air?
water=1; // should this projectile be created on water?
ground=1; // should this projectile be created when on ground?
count=10; // number of projectiles of this type
}
.. other projectiles types can follow here ..
}

Defaults for air/underwater/ground/water are zero.
Default of count is 1.

=== Projectile properties ===

To begin, you should run
spring /p (or "spring -p" on linux)
to let spring export "projectiles.txt", which contains all the classes you can use in an explosion script. At the time of writing, this would contain [[projectiles.txt]]

The items listed in "properties" are directly mapped to the class properties in projectiles.txt
The properties are specified with a bit of a cryptic syntax. You can use extra commands in them (r,d,i). For example this:

pos = -30 r60, r30, -30 r60;

The x coordinate (specified with -30 r60) will be:
x = -30 + (Random value between 0 and 60);

Commands:
rX: add a number between 0 and X
iX: multiply the projectile index with X and add it. See the example for this below.
dX: multiply the damage with X and add it.

== Explosion script examples ==

This is an example of a script that makes 10 smoke projectiles (yeah they should have been called particles, but they are handled by spring using the projectile system)

[ARM_HLT_Expl]
{
[smoke]
{
[properties]
{
// age increase per frame, when age >= 1 the particle is destroyed
ageSpeed=0.04;

size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60;
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
water=1;
ground=1;
count=10;
}
}

This particular script would be linked to with "explosiongenerator=custom:ARM_HLT_Expl;"

Here is an example that uses the index (i) command in the properties:

[heatcloud]
{
[properties]
{
pos = 0, i20, 0;
heat = 10;
maxheat=10;
heatFalloff=1;
size = 30;
}
ground=1;
count=10;
}

This script creates a tower of heatcloud projectile. The first projectile gets y=0, the second y=20, y=40, y=60, .. and finally y=180

=== How to link a custom explosion to a weapon ===

The weapon definitions needs to have this in it:
explosiongenerator = custom:ExplosionScriptName;

The explosion definition for ExplosionScriptName would be one of the TDF files in gamedata/explosions/

You can also link the weapons for self-destruct and normal destruct to an explosion script.

=== Adding ground flashes ===

The ground flash is currently not an actual projectile, so it's specified in a different way:
[ARM_HLT_Expl]
{
.. projectiles definitions ..

[groundflash]
{
flashSize = 100; // flash size
flashAlpha = 1; // initial alpha of the flash
circleGrowth = 60; // size increase/frame
circleAlpha = 1; // initial alpha of the ring
ttl = 10; // number of frames
color = 0,0,1; // color RGB
}
}

== Projectile classes usable in explosion generators ==
[[dirt]] 
[[heatcloud]] 
[[smoke]] 
[[smoke2]] 
[[gfx]] 
[[bitmapmuzzleflame]] 

== Keywords ==
These are keywords that can be used in the explosiongenerator script to give a propertier a special value.

CColorMap

2006-09-29T23:52:07Z

Yeha:

AtlasedTexture

2006-09-29T23:47:21Z

Yeha:

AtlasedTexture is an alias to a texture. This means the alias must be defined somewhere and pointing to to a real texture. For AtlasedTextures used in projectiles (like those spawned by explosiongenerator) they need to be defined in [[resources.tdf]] under the [projectiletextures].

A line defining a texture alias in [[resources.tdf]] looks like this: 
<code>alias=real_image.tga;</code>
Most spring suported image format can be used in AtlasedTextures, but not compressed dds.

Bitmapmuzzleflame

2006-09-29T23:38:43Z

Yeha:

Bitmapmuzzleflame is a simple projectile usefull for making a muzzleflame with two textures, one as the muzzleflame seen from the sides and one as seen from the front.

'''Propertiers for Bitmapmuzzleflame:'''

<ul>
<li>
'''[[AtlasedTexture]] sideTexture''' 
Defines the texture for the sides of the flame.
</li> 

<li>
'''[[AtlasedTexture]] frontTexture''' 
Defines the texture for the muzzleflame as seen from the front.
</li> 

<li>
'''float3 dir''' 
Direction of the flame.
</li> 

<li>
'''[[CColorMap]] colorMap''' 
Colormap describing the colors during the flame lifetime.
</li> 

<li>
'''float size''' 
Initial hight and width of flame.
</li> 

<li>
'''float length''' 
Initial length of the flame, this is the size in the direction the flame is pointing.
</li> 

<li>
'''float sizeGrowth''' 
This is how much the flame will grow during its lifetime. A value of 0 means the flame will stay the same size during its entire lifetime. A value of 1 means that it will have grown to dubbel its size when its life end. The growth curve is exponential, faster in the beginning and slower at the end.
</li> 

<li>
'''int ttl''' 
How many frames the flame will be visible.
</li> 

<li>
'''float frontOffset''' 
Offset for the front texture in percent of length. 0 means the front will at the beginning of the flame, 0.5 in the middle, and 1 at the end.
</li> 
</ul>

Bitmapmuzzleflame

2006-09-29T23:29:15Z

Yeha:

Bitmapmuzzleflame is a simple projectile usefull for making a muzzleflame with two textures, one as the muzzleflame seen from the sides and one as seen from the front.

'''Propertiers for Bitmapmuzzleflame:'''

*[[AtlasedTexture]] sideTexture 
Defines the texture for the sides of the flame.

*[[AtlasedTexture]] frontTexture 
Defines the texture for the muzzleflame as seen from the front.

*float3 dir 
Direction of the flame.

*[[CColorMap]] colorMap 
Colormap describing the colors during the flame lifetime.

*float size 
Initial hight and width of flame.

*float length 
Initial length of the flame, this is the size in the direction the flame is pointing.

*float sizeGrowth 
This is how much the flame will grow during its lifetime. A value of 0 means the flame will stay the same size during its entire lifetime. A value of 1 means that it will have grown to dubbel its size when its life end. The growth curve is exponential, faster in the beginning and slower at the end.

*int ttl 
How many frames the flame will be visible.

*float frontOffset 
Offset for the front texture in percent of length. 0 means the front will at the beginning of the flame, 0.5 in the middle, and 1 at the end.

Bitmapmuzzleflame

2006-09-29T23:28:50Z

Yeha:

Bitmapmuzzleflame is a simple projectile usefull for making a muzzleflame with two textures, one as the muzzleflame seen from the sides and one as seen from the front.

'''Propertiers for Bitmapmuzzleflame:'''

*[[AtlasedTexture]] sideTexture 
Defines the texture for the sides of the flame.

*[[AtlasedTexture]] frontTexture 
Defines the texture for the muzzleflame as seen from the front.

*float3 dir 
Direction of the flame.

*[[CColorMap]] colorMap 
Colormap describing the colors during the flame lifetime.

*float size 
Initial hight and width of flame.

*float length 
Initial length of the flame, this is the size in the direction the flame is pointing.

*float sizeGrowth 
This is how much the flame will grow during its lifetime. A value of 0 means the flame will stay the same size during its entire lifetime. A value of 1 means that it will have grown to dubbel its size when its life end. The growth curve is exponential, faster in the beginning and slower at the end.

*int ttl 
How many frames the flame will be visible.

float frontOffset 
Offset for the front texture in percent of length. 0 means the front will at the beginning of the flame, 0.5 in the middle, and 1 at the end.

CEG-OldInfo

2006-09-29T23:08:44Z

Yeha: /* Projectile classes usable in explosion generators */

CEG-OldInfo

2006-09-29T23:07:47Z

Yeha: /* Projectile classes usable in explosion generators */

== Custom explosion generators ==

=== What are they? ===
Custom explosions are small explosion scripts read from gamedata/explosions/*.tdf.
The explosion script specifies which particles/projectiles have to be created when the explosion happens, and their initial properties (position,speed,...)

=== Explosion script definition ===

The explosion script directly specifies which C++ projectile classes have to be created, and also which properties the projectiles should have.

The explosion script is structured like this:

[ExplosionScriptName]
{
[projectile scriptname] // this specifies the class of the projectile
{
[properties]
{
size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60; // These codes are explained below
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
underwater=0; // should this projectile be created when underwater?
air=0; // should this projectile be created when in air?
water=1; // should this projectile be created on water?
ground=1; // should this projectile be created when on ground?
count=10; // number of projectiles of this type
}
.. other projectiles types can follow here ..
}

Defaults for air/underwater/ground/water are zero.
Default of count is 1.

=== Projectile properties ===

To begin, you should run
spring /p (or "spring -p" on linux)
to let spring export "projectiles.txt", which contains all the classes you can use in an explosion script. At the time of writing, this would contain [[projectiles.txt]]

The items listed in "properties" are directly mapped to the class properties in projectiles.txt
The properties are specified with a bit of a cryptic syntax. You can use extra commands in them (r,d,i). For example this:

pos = -30 r60, r30, -30 r60;

The x coordinate (specified with -30 r60) will be:
x = -30 + (Random value between 0 and 60);

Commands:
rX: add a number between 0 and X
iX: multiply the projectile index with X and add it. See the example for this below.
dX: multiply the damage with X and add it.

== Explosion script examples ==

This is an example of a script that makes 10 smoke projectiles (yeah they should have been called particles, but they are handled by spring using the projectile system)

[ARM_HLT_Expl]
{
[smoke]
{
[properties]
{
// age increase per frame, when age >= 1 the particle is destroyed
ageSpeed=0.04;

size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60;
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
water=1;
ground=1;
count=10;
}
}

This particular script would be linked to with "explosiongenerator=custom:ARM_HLT_Expl;"

Here is an example that uses the index (i) command in the properties:

[heatcloud]
{
[properties]
{
pos = 0, i20, 0;
heat = 10;
maxheat=10;
heatFalloff=1;
size = 30;
}
ground=1;
count=10;
}

This script creates a tower of heatcloud projectile. The first projectile gets y=0, the second y=20, y=40, y=60, .. and finally y=180

=== How to link a custom explosion to a weapon ===

The weapon definitions needs to have this in it:
explosiongenerator = custom:ExplosionScriptName;

The explosion definition for ExplosionScriptName would be one of the TDF files in gamedata/explosions/

You can also link the weapons for self-destruct and normal destruct to an explosion script.

=== Adding ground flashes ===

The ground flash is currently not an actual projectile, so it's specified in a different way:
[ARM_HLT_Expl]
{
.. projectiles definitions ..

[groundflash]
{
flashSize = 100; // flash size
flashAlpha = 1; // initial alpha of the flash
circleGrowth = 60; // size increase/frame
circleAlpha = 1; // initial alpha of the ring
ttl = 10; // number of frames
color = 0,0,1; // color RGB
}
}

== Projectile classes usable in explosion generators ==
[[dirt]]
[[heatcloud]]
[[smoke]]
[[smoke2]]
[[gfx]]
[[bitmapmuzzleflame]]

CEG-OldInfo

2006-09-29T23:05:35Z

Yeha:

CEG-OldInfo

2006-09-29T23:02:16Z

Yeha: /* Explosion script examples */