Spring - User contributions [en]

Development:Main

2007-12-23T14:22:33Z

ILMTitan: /* Development links */

Outlined below is information on assisting with the development of the Spring source itself.

::<small>NOTE: For information about developing a mod (units, maps, etc.) see the [[Mod Development]] page.</small>

Below you can find information on how to work with the Spring source in the current mainline (Windows platform) if you like to work on another platform (Linux & Mac) please look at the bottem of this page under "Multiplatform development"

==Starting Development==
To start development, you will need
#The latest version of the source
#A good code manipulation program
#Compiling your modified source

== Keep track what others do ==
If you develop with others, you need to know what they do. We have [http://spring.clan-sy.com/fisheye/ fisheye], a very handy SVN helper, and [http://spring.clan-sy.com/websvn/ WebSVN] running on the server.

===Source Code Documentation===
A good place to start is [http://buildbot.no-ip.org/~buildbot/spring/doxygen the source code documentation].

An explanation on how the code is executed in game can be found in the [[Spring Engine Code]]
page.

==Obtaining the Source==
The latest SVN is at: [https://spring.clan-sy.com/svn/spring https://spring.clan-sy.com/svn/spring]

Another option is to manually [http://spring.clan-sy.com/download.php download] it along with the latest released version of the game. However, for serious developers, a better way would be to download the source straight from the subversion (SVN) repository. This will also allow you to make a patch out of the changes you make to the code, and send it to one of the developers with SVN access.

Windows SVN clients : [http://subversion.tigris.org Subversion] (Win32-Console),
[http://www.syntevo.com/smartsvn/index.jsp SmartSVN] (Java) and [http://tortoisesvn.tigris.org TortoiseSVN] (MSI).

Assuming that you are using the Subversion svn client you can download the latest SVN source with

<code>svn.exe checkout https://spring.clan-sy.com/svn/spring/trunk</code>

It will create a trunk subdirectory in the directory from where you ran it, which will contain the source code root directory which will be later referred to as /spring

==Learning C++==
You will need to know C++ to modify or understand Spring's source code. If you are interested in learning C++, see [[Learning_CPP]]

However please note that badly designed code (code created by a C++ novice for example), even if working will likely not be included in the spring code. Spring is a large project, and therefore it is necessary to stay away from hack jobs and create general solutions to problems.

==Setting up your development environment==
You have either to use the SCons build system that is multi platform, or use Microsoft Visual Studio for building spring. See also [[Development_IDEs]] for some more background information about the IDE to choose.

===Visual Studio 8 (2005)===
(possibly the free Express Edition)

* Install the [http://xta.wolfgame.org/SimBase/vclibs.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories:
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the release/no debug build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

===SCONS/MinGW===
Code::Blocks and Dev C++ use MinGW too, so if you are using one of these IDEs, you'll want to follow these instructions too.

Get [http://www.unknown-files.net/spring/3839/mingwlibsv10/ the MinGW library package]. Make sure you install it it the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/mingwlibs

These programs are a must have if you want to compile Spring with MinGW, so install them now, if you don't have them already. (TODO: update links to point to Python 2.5)

*[http://www.python.org/ftp/python/2.4.2/python-2.4.2.msi Python 2.4 installer]
*[http://prdownloads.sourceforge.net/pywin32/pywin32-208.win32-py2.4.exe?download Python win32 extensions installer]
*[http://prdownloads.sourceforge.net/scons/scons-0.96.1.win32.exe Scons installer]

Oh, and quick instructions:

* Grab and install the above programs.
* Make sure C:\Python24 and C:\Dev-Cpp\bin are in your PATH environment variable. Set environment variables by: Start -> Settings -> Control Panel -> System -> Advanced -> Environment variables (for Windows XP).
* Make sure a MINGDIR environment variable with value C:\Dev-Cpp exists. (change paths where appropriate.)
* Checkout the Spring SVN repository, following the instructions above in obtaining source. (TODO:link)
* Open a console (Start -> Run -> cmd.exe -> Run), cd \where you checked it out in the previous step, if you checked it out on a different drive make sure to change drives with DriveLetter:<enter> first.
* Type scons configure<enter>. Refer to scons --help for options which can be passed to scons configure. Gotchas:
** If you get an error message starting with "EOFError: : env = Environement...", try deleting the file build/scons_signatures.dblite
** If you get an error message stating "ImportError: No module named win32file:", you have probably not installed the python-win32-extensions.
** If all proceeds as intended you will see a message similar to: "Everything seems OK. Run `scons' now to build."
* Type scons<enter> to start the compilation.
* Wait for the compilation to finish, this may take a while.
* Copy datafiles and stuff from official Spring installation to the /spring/game directory (where spring.exe is located, after the compilation finished.)
* Copy missing DLLs from mingwlibs/dll.
* Start developing.

If you are using Linux, refer to the [[SetupGuide]] to build Spring and get it running.

==Development Suggestions==
Before starting to make modifications to the source, take a look at the [[development guidelines]] which outlines some important things to think about. To find something interesting to work on, look at the list of [[example projects]]. You can also check the list of [[whois doing what]] to see what others are doing. If you do edit the code, please add [[Doxygen style comments]] to the code, which will then enhance the source code documentation.

==How to get your code included==
If you create something that you think should be included in the official source tree, you can report a "bug" in [http://spring.clan-sy.com/mantis/ mantis, our BTS]. Add your patch as attachment, and put "[patch]" in front of the subject, so it is easy for us to separate patches from bugs.

It's also considered standard practice to post one's modifications in the [http://spring.clan-sy.com/phpbb/viewforum.php?f=12 development forum] and get feedback.

==Spring Engine TODO list==
There is a TODO list for developers who want to contribute to the engine itself:
[[SpringEngineTODO]]. There is also a [http://spring.clan-sy.com/phpbb/viewforum.php?f=21 feature request forum], which may give you some ideas. Don't be overwhelmed by the sheer number of (silly) requests though!

==Development links==
* [http://buildbot.no-ip.org/~buildbot/spring/executable/ Automatic builds (crosscompiled, mingw)]
* [http://buildbot.no-ip.org/~buildbot/spring/installer/ Automatic installer builds (crosscompiled, mingw)]
* [http://developer.berlios.de/projects/taspring-linux BerliOS project page (OLD)]
* [http://spring.clan-sy.com/mantis Bug Tracking System]
* [http://buildbot.no-ip.org:8010/ Buildbot]
* [https://lists.berlios.de/mailman/listinfo/taspring-linux-commit Commit mailing list]
* [http://spring.clan-sy.com/dl/spring-vc8libs.exe Development libraries for Visual Studio 2005]
* [http://www.unknown-files.net/spring/3839/mingwlibsv10/ Development libraries for MinGW]
* [http://lolut.utbm.info/cgi-bin/mailman/listinfo/taspring-linux Developers mailing list (practically dead, use this forum instead) (DOWN)]
* [http://buildbot.no-ip.org/~buildbot/spring/doxygen Doxygen pages of the latest source (regenerated nightly)]
* [http://spring.clan-sy.com/fisheye Fisheye interface to SVN]
* [http://sourceforge.net/projects/springrts SourceForge project page (OLD)]
* [http://buildbot.no-ip.org/~buildbot/spring/stacktraceTranslator.php StackTrace Translator]
* [https://spring.clan-sy.com/svn/spring/trunk/ Subversion repository]
* [http://spring.clan-sy.com/websvn/listing.php?repname=spring&path=%2F&sc=0 WebSVN]
* [http://spring.clan-sy.com/websvn/log.php?repname=spring&path=%2F&rev=0&sc=0&isdir=1 WebSVN link to "development log"]
* [http://spring.clan-sy.com/websvn/filedetails.php?repname=spring&path=%2Ftrunk%2FDocumentation%2Fchangelog.txt&rev=0&sc=0 WebSVN link to the most recent changelog.txt]

[[Category:Development]] [[Category:Source development]]

Weapon Variables

2007-09-24T05:33:24Z

ILMTitan: /* Weapon Variable Descriptions */

<center>
=Weapon Variable Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>Accuracy</TD>
<TD>How accurate a weapon is. A larger number is less accurate. If this tag is missing entirely, it has perfect accuracy unless its target moves unexpectedly. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high accuracy value will probably still hit. If a target is very far away, even a very low accuracy value will likely cause the weapon to miss. Can be any numeric value.</TD>
<TD>accuracy=400;</TD>
</TR>
<TR>
<TD>AreaOfEffect</TD>
<TD>How large the weapon's impact explosion is. This affects how powerful the weapon's default impulse strength will be. Currently, BeamLasers with an AreaOfEffect of 16 or above will deform the ground at their point of impact regardless of whether it has been told not to. Can be any numeric value, but should generally be at least 8, regardless of the type of weapon.</TD>
<TD>areaofeffect=192;</TD>
</TR>
<TR>
<TD>Ballistic</TD>
<TD>Set to 1 for the weapon to be subjected to gravity, travelling in an arc through the air, such as cannons. Ballistic is mutually exclusive to LineOfSight and Dropped. Can be 1 or 0.</TD>
<TD>ballistic=1;</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>Whether this weapon is a beam laser or not. Beam lasers instantly hit their targets. Rendertype must be 0. Mutually exclusive to BeamWeapon. Can be 1 or 0.</TD>
<TD>beamlaser=1;</TD>
</TR>
<TR>
<TD>BeamTime</TD>
<TD>How long to fire the laser before waiting for ReloadTime to start. Can be any numeric value. Defaults to 1.</TD>
<TD>beamtime=0.5;</TD>
</TR>
<TR>
<TD>BeamWeapon</TD>
<TD>Whether this weapon is a regular laser or not. BeamWeapons (lasers) do not instantly hit their targets, and are affected by the weaponvelocity tag. Mutually exclusive to BeamLaser. Can be 1 or 0.</TD>
<TD>beamweapon=1;</TD>
</TR>
<TR>
<TD>BounceRebound</TD>
<TD>The amount of vertical velocity a projectile keeps when it bounces. Generally .3-1, but 0 for a sticky bomb, or 2 for a flubber bomb. Defaults to 1</TD>
<TD>bouncerebound=.8;</TD>
</TR>
<TR>
<TD>BounceSlip</TD>
<TD>The amount of horizontal velocity a projectile keeps when it bounces. Generally .3-1, but 0 for a sticky bomb, or 2 for a flubber bomb. Defaults to 1</TD>
<TD>bounceslip=.8;</TD>
</TR>
<TR>
<TD>BurnBlow</TD>
<TD>The weapon blows up at the end of its range, only works on plasma (rendertype=4) weapons last I checked. Can be 1 or 0. A common usage is on flak guns.</TD>
<TD>burnblow=1;</TD>
</TR>
<TR>
<TD>Burst</TD>
<TD>How many shots are in a burst. Must be accompanied by burstrate. Can be any numeric value.</TD>
<TD>burst=3;</TD>
</TR>
<TR>
<TD>BurstRate</TD>
<TD>How fast the Burst fires. If set much below 0.1, it stops having any discernable effect.</TD>
<TD>burstrate=0.1</TD>
</TR>
<TR>
<TD>Color</TD>
<TD>An obsolete tag only recognized for compatibility purposes. While this still works for lasers, using rgbcolor=X X X; is a much, much better route. Plus, the RGBColor tag will override any color=x; tags in the tdf. </TD>
<TD>color=1;</TD>
</TR>
<TR>
<TD>Color2</TD>
<TD>An obsolete tag only recognized for compatibility purposes.</TD>
<TD>color=2;</TD>
</TR>
<TR>
<TD>CommandFire</TD>
<TD>When ordered to attack ground this weapon will only fire once, rather than continuously. This does not work when ordered to attack units (It will continue to fire until the target is dead). If the unit has CanDgun=1 in its FBI, commandfire will identify that weapon with the dgun button. The weapon wont fire unless the dgun button is pressed. Can be set to 1 or 0.</TD>
<TD>commandfire=1;</TD>
</TR>
<TR>
<TD>Coverage</TD>
<TD>The range for anti-weapon weapons, like antinukes. This will be shown on the minimap as a guide. Can be any numeric value.</TD>
<TD>coverage=1280;</TD>
</TR>
<TR>
<TD>Dropped</TD>
<TD>Sets the weapon to be dropped, like from a bomber. Must be RenderType=6 and needs the Model tag to be specified. Mutually exclusive to Ballistic and LineOfSight. Can be set to 1 or 0.</TD>
<TD>dropped=1;</TD>
</TR>
<TR>
<TD>Duration</TD>
<TD>For how many seconds a beam weapon will be fired before waiting for reload time. Can be any numeric value. Used for rendertype 0 and 7 weapons.</TD>
<TD>duration=.5;</TD>
</TR>
<TR>
<TD>EdgeEffectiveness</TD>
<TD>Determines what percent of a weapon's maximum damage value will be applied to units as they are closer to the outer edge of the weapon's AreaOfEffect. Must have a decimal value between 0 and 1. Default in OTA was 0, probably the same in Spring.</TD>
<TD>edgeeffectiveness=0.25;</TD>
</TR>
<TR>
<TD>EnergyPerShot</TD>
<TD>Energy used per shot. If the specified amount of energy is not available, the weapon will not be able to shoot. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be any numeric value.</TD>
<TD>energypershot=5;</TD>
</TR>
<TR>
<TD>FireStarter</TD>
<TD>How likely the weapon will set trees on fire. High values make trees likey to be set on fire, low values make trees likely to just explode or tip over. Can be any numeric value between 0 and 100.</TD>
<TD>FireStarter=75;</TD>
</TR>
<TR>
<TD>GroundBounce</TD>
<TD>Weather the weapon projectile will bounce on the ground (on land or the ocean floor). Can be 0 or 1, defaults to 0 (off)</TD>
<TD>groundbounce=1;</TD>
</TR>
<TR>
<TD>Guidance</TD>
<TD>Specifies whether or not the weapon is capable of correcting its trajectory mid-flight. Will not track a moving target. Works only on missile and torpedo weapons. Can be set to 1 or 0. See TurnRate for information on specifying how well a weapon can track a target. Requires rendertype=1, lineofsight=1, and selfprop=1;</TD>
<TD>guidance=1;</TD>
</TR>
<TR>
<TD>ImpulseFactor</TD>
<TD>The multiplier on the weapon's default impulsefactor, which is determined based on a weapon's default damage and AreaOfEffect. The impulse of a weapon is how strong of a kinetic force will be applied to its target or anything near the point of impact. Can be any numeric value, including negative ones.</TD>
<TD>impulsefactor=2.5;</TD>
</TR>
<TR>
<TD>Intensity</TD>
<TD>Alpha (brighness and washout effect) of the weapon. Can be used on any rendertype 0, 3, or 4 weapon. Can be any numeric value.</TD>
<TD>intensity=1.5;</TD>
</TR>
<TR>
<TD>InterceptedByShieldType</TD>
<TD>Bitfield representing the types of shields that can intercept this weapon. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a shield with that digit set to one will intercept this weapon, for instance, the example will result in the weapons being blocked by shields with types 1 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>InterceptedByShieldType=5;</TD>
</TR>
<TR>
<TD>Interceptor</TD>
<TD>Can intercept missiles with the Cruise tag.</TD>
<TD>interceptor=1;</TD>
</TR>
<TR>
<TD>LineOfSight</TD>
<TD>LineOfSight weapons ignore gravity and must have a direct line from the firing point to the impact point in order to be fired. Can be set to 1 or 0. Mutually exclusive to Ballistic and Dropped.</TD>
<TD>lineofsight=1;</TD>
</TR>
<TR>
<TD>MetalPerShot</TD>
<TD>Metal used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be set to any numeric value.</TD>
<TD>metalpershot=500;</TD>
</TR>
<TR>
<TD>Model</TD>
<TD>The 3DO or S3O model to be used as this weapon's physical representation. 3DO modesl do not need a .3do extension, but S3O weapon do.</TD>
<TD>model=missile;</TD>
</TR>
<TR>
<TD>MovingAccuracy</TD>
<TD>A weapon's accuracy while moving. See Accuracy. Can be any numeric value.</TD>
<TD>movingaccuracy=1000;</TD>
</TR>
<TR>
<TD>NoExplode</TD>
<TD>Whether or not the weapon will explode on impact or continue on its path. An example is the d-gun. Can be set to 1 or 0.</TD>
<TD>noexplode=1;</TD>
</TR>
<TR>
<TD>NoSelfDamage</TD>
<TD>This weapon will not damage the unit that fired it. For instance, a nuke silo could shoot itself and not take any damage if this was active. Can be set to 1 or 0.</TD>
<TD>noselfdamage=1;</TD>
</TR>
<TR>
<TD>NumBounce</TD>
<TD>The maximum number of times a weapon will bounce. -1 for infinite. Defaults to -1</TD>
<TD>numbounce=5;</TD>
</TR>
<TR>
<TD>Paralyzer</TD>
<TD>If active, this weapon will not cause any damage to its target, but will instead paralyze (aka EMP). The default damage value of a weapon with this active will be applied to the target's HP; once the HP is overwhelmed, it will be paralyzed. Can be set to 1 or 0.</TD>
<TD>paralyzer=1;</TD>
</TR>
<TR>
<TD>ParalyzerTime</TD>
<TD>On Paralyzer weapons, determines the maximum length of time the target will be paralyzed (In seconds?). The timer is refreshed every time the target is hit by the weapon. Can be set to any numerical value.</TD>
<TD>paralyzetime=15;</TD>
</TR>
<TR>
<TD>Range</TD>
<TD>The maximum range of the weapon. If set to noexplode, the weapon will disappear after this range has been met. If set to burnblow, the weapon will explode after this range has been met. Can be set to any numerical value.</TD>
<TD>range=750;</TD>
</TR>
<TR>
<TD>ReloadTime</TD>
<TD>The amount of time between shots. If a unit is paralyzed, this stops counting down. Can be set to any numerical value.</TD>
<TD>reloadtime=3.5;</TD>
</TR>
<TR>
<TD>Rendertype</TD>
<TD>The way the weapon will be displayed. Certain rendertypes are incompatibile with other tags, but it's generally for a logical reason. The rendertypes are as follows: 0 - Laser, 1 - Model, 3 - Plasma, 4 - Unit explosion (usally), 5 - Flamethrower, 6 - Dropped, 7 - Lightning. There's no documented use of rendertype=2 in OTA, and it probably doesn't do anything in Spring. 3 and 4 are usually interchangeable, both can be used to render a plasma/EMG/whatever shot; this is probably for compatibility.</TD>
<TD>rendertype=1;</TD>
</TR>
<TR>
<TD>RGBColor</TD>
<TD>The color of the rendertype 0, 3, 4, 7 weapon, specified in RED_GREEN_BLUE format.</TD>
<TD>rgbcolor=1 0.3 1; - this would make evul-purple</TD>
</TR>
<TR>
<TR>
<TD>RGBColor2</TD>
<TD>The color at the core of a rendertype 0 (laser) weapon. Specified the same as above. Defaults to white.</TD>
<TD>RGBColor2=0 1 0; - this would make a weird green middle for the evul-purple laser</TD>
</TR>
<TR>
<TD>Selfprop</TD>
<TD>Required for Guidance tag. This weapon can propel itself and can have things like acceleration, rather than always travelling at one speed. See Guidance, StartVelocity, WeaponAcceleration, WeaponVelocity. Can be set to 1 or 0.</TD>
<TD>selfprop=1;</TD>
</TR>
<TR>
<TD>SmokeTrail</TD>
<TD>Does the projectile leave a smoke trail or not. Can be set to 1 or 0.</TD>
<TD>smoketrail=1;</TD>
</TR>
<TR>
<TD>SoundHit</TD>
<TD>The sound made whe the weapon hits. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundhit=emghit;</TD>
</TR>
<TR>
<TD>SoundStart</TD>
<TD>The sound made when the weapon begins to fire. Will fire only once if the weapon is shot in a burst. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundstart=emgfire;</TD>
</TR>
<TR>
<TD>SoundTrigger</TD>
<TD>If active, the weapon will sound every time a shot is fired in a burst sequence. Can be set to 1 or 0.</TD>
<TD>soundtrigger=1;</TD>
</TR>
<TR>
<TD>SprayAngle</TD>
<TD>How wide the the angle of a burst from a burst weapon can be. Very similar to Accuracy, except that if a weapon has no sprayangle, all the shots will be fired at the same spot, even if the weapon's aim is off.</TD>
<TD>sprayangle=1024;</TD>
</TR>
<TR>
<TD>StartVelocity</TD>
<TD>The starting speed of the weapon as it is first fired. Only applicable to weapons that can accelerate.</TD>
<TD>startvelocity=200;</TD>
</TR>
<TR>
<TD>Stockpile</TD>
<TD>Can this weapon be stockpiled, for instance like a nuke launcher. Can be set to 1 or 0.</TD>
<TD>stockpile=1;</TD>
</TR>
<TR>
<TD>Targetable</TD>
<TD>If active, the weapon will be automatically targeted by any Interceptor weapons.</TD>
<TD>targetable=1;</TD>
</TR>
<TR>
<TD>TargetMoveError</TD>
<TD>The degree to which a weapon's aiming will fail to keep up with its target's movement. If set very low or not set at all, a weapon will lead its target and almost always hit unless there's a lot of micromanagement on the part of the person controlling the target. If set too high (about 0.3 or above), the weapon will have a lot of difficulty even tracking its target enough to get a shot off. Can probably only be set between 0 and 1. Beyond 1, the weapon would be virtually useless.</TD>
<TD>targetmoveerror=0.15;</TD>
</TR>
<TR>
<TD>Thickness</TD>
<TD>Thickness of a beamweapon or beamlaser, default is 2. Can be set to any numerical value.</TD>
<TD>thickness=4;</TD>
</TR>
<TR>
<TD>ToAirWeapon</TD>
<TD>If active, the weapon will only be capable of targetting units which are flying, or are capable of flying. Can be set to 0 or 1.</TD>
<TD>toairweapon=1;</TD>
</TR>
<TR>
<TD>Tolerance</TD>
<TD>The amount to which the weapon's "real" aim can be off while the weapon will still be able to fire accurately at the target. This worked in OTA, but I'm not 100% sure if it works in Spring. Can be set to any numerical value.</TD>
<TD>tolerance=1500;</TD>
</TR>
<TR>
<TD>Tracks</TD>
<TD>If the missile tracks a moving target. Can be set to 1 or 0.</TD>
<TD>tracks=1;</TD>
</TR>
<TR>
<TD>TrajectoryHeight</TD>
<TD>The height of the arc of a missile weapon. It is useful for compensating for mountains or debris. Is relative to the weapons speed (Higher speed, higher arc) and the range the weapon is firing at (Lower range lower arc). Requires Guidance and Turnrate to hit its target when over 1. </TD>
<TD>trajectoryheight=0.8;</TD>
</TR>
<TR>
<TD>Turnrate</TD>
<TD>How fast a guided weapon can turn. Can be any numerical value between 0 and 64000. If set to 0, the weapon can't turn at all, if set to 64000, the weapon can literally defy all known physics and turn 180 degrees in a fraction of a second. This is relative to a weapon's velocity; a weapon with a very low velocity (~200) wouldn't need a very high turnrate to keep up with a fighter, although it would probably never catch it because of its slow speed. A weapon with a very high velocity (~1000) would need a very high value in order to be able to hit targets that turn suddenly.
<TD>turnrate=32000;</TD>
</TR>
<TR>
<TD>Turret</TD>
<TD>Set to 1 if weapon is used by a turret that rotates. Set to 0 if weapon is forward firing, ie, has no rotating turret piece.</TD>
<TD>turret=1;</TD>
</TR>
<TR>
<TD>TwoPhase</TD>
<TD>Weapon operates in two phases... eh... yeah, I honestly have no idea what the difference between this and VLaunch is. Generally use it with VLaunch as well. Can be set to 1 or 0.</TD>
<TD>twophase=1;</TD>
</TR>
<TR>
<TD>VLaunch</TD>
<TD>Set to 1 to launch the weapon vertically. Can only be used with missile-type weapons with a TurnRate. Cannot be used at the same time as Turret. Set to 1 or 0.</TD>
<TD>vlaunch=1;</TD>
</TR>
<TR>
<TD>WaterBounce</TD>
<TD>Weather the weapon projectile will bounce on the surface of the water. Can be 0 or 1, defaults to 0 (off)</TD>
<TD>waterbounce=1;</TD>
</TR>
<TR>
<TD>WaterWeapon</TD>
<TD>Water weapons behave somewhat like Dropped weapons out of water, and like missiles underwater. Is the only type of weapon that can fire under water. Can be set to 1 or 0.</TD>
<TD>waterweapon=1;</TD>
</TR>
<TR>
<TD>WeaponAcceleration</TD>
<TD>Tells the weapon how fast it should accelerate from its StartVelocity to its actual WeaponVelocity. Increases the weapon's velocity every second by the amount specified. Can be any numerical value.</TD>
<TD>weaponacceleration=50;</TD>
</TR>
<TR>
<TD>WeaponTimer</TD>
<TD>How long until the weapon will go into its second phase. For use with missile weapons. For VLaunch weapons, the weapon will turn to actually go towards its target after the specified number of seconds has expired. For non-VLaunch missiles with a TurnRate, the weapon will go randomly off-course after this period of time. Can be set to any numerical value.</TD>
<TD>weapontimer=5;</TD>
</TR>
<TR>
<TD>WeaponVelocity</TD>
<TD>The speed the weapon moves after being fired. If StartVelocity is lower than this number, the weapon will increase speed to its WeaponVelocity at the rate specified by its WeaponAcceleration.</TD>
<TD>weaponvelocity=800;</TD>
</TR>
<TR>
<TD>Wobble</TD>
<TD>The amount that a missile will wobble off-course. Requires TurnRate. Turnrate will wrestle with wobble to keep the weapon on course, so wobble must be high enough to compensate to have any effect. Can be set to any numerical value between 0 and 64000.</TD>
<TD>wobble=15000;</TD>
</TR>
</table>
<BR><BR><BR>

NOTE: Variables that are defined by either a 1 or a 0 are BOOLEAN, where 1 means TRUE and 0 means FALSE.

NOTE 2: "Any numerical value" for things that relate to angles really means any value between 0 and 64,000 since that's between 0 and 360 degrees in spring measurement. Setting it higher than 64,000 will bring it 'full circle' so to speak.

=Shield/Repulsor Variable Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>ExteriorShield</TD>
<TD>If set to 1, the shield/repulsor will not have any effect on weapons fired from within its field. Can be 1 or 0.</TD>
<TD>exteriorshield=1;</TD>
</TR>
<TR>
<TD>IsShield</TD>
<TD>If set to 1, this "weapon" is no longer a weapon, is now a repulsor or a shield, based on the other properties given to it. Can be 1 or 0.</TD>
<TD>isshield=1;</TD>
</TR>
<TR>
<TD>ShieldAlpha</TD>
<TD>How clearly visible the shield is, if you have VisibleShield turned on. Value is between 0 and 1.</TD>
<TD>shieldalpha=0.4;</TD>
</TR>
<TR>
<TD>ShieldEnergyUse</TD>
<TD>The amount of energy used to repulse or destroy weapons. Will be used constantly while the weapon is in its area of effect if it is a repulsor, will be used only once on impact if it is a shield.</TD>
<TD>shieldenergyuse=1500;</TD>
</TR>
<TR>
<TD>ShieldForce</TD>
<TD>The force applied to weapons, an arbitrary number. Set to 1, it will not deflect very well. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldforce=1.75;</TD>
</TR>
<TR>
<TD>ShieldBadColor</TD>
<TD>The color the shield is when it is at 0% strength, if you have VisibleShield turned on. Defined in R G B format.</TD>
<TD>shieldbadcolor=0 1 0;</TD>
</TR>
<TR>
<TD>ShieldGoodColor</TD>
<TD>The color the shield is when it is at 100% strength, if you have VisibleShield turned on.</TD>
<TD>shieldgoodcolor=1 0 0;</TD>
</TR>
<TR>
<TD>ShieldInterceptType</TD>
<TD>Bitfield representing the types of weapons that this shield can intercept. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a weapon with that digit set to one will be intercepted by this shield, for instance, the example will result in the shield blocking weapons with types 2 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>ShieldInterceptType=6;</TD>
</TR>
<TR>
<TD>ShieldMaxSpeed</TD>
<TD>The maximum speed the repulsor will push weapons away at. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldmaxspeed=400;</TD>
</TR>
<TR>
<TD>ShieldPower</TD>
<TD>How much "power" a shield can store. "Power" is not the same as energy; think of it as the shield/repulsor's private battery source. It can be drained completely by defending against weapons, even if you have lots of energy. ''Power is drained by the affected weapons damage.'' Can be set to any numerical value.</TD>
<TD>shieldpower=1000;</TD>
</TR>
<TR>
<TD>ShieldPowerRegen</TD>
<TD>How quickly the shield regenerates its "power", even when under attack. Regenerates the amount specified every second. Can be set to any numerical value.</TD>
<TD>shieldpowerregen=25;</TD>
</TR>
<TR>
<TD>ShieldPowerRegenEnergy</TD>
<TD>How much energy is required to keep the shield regenerating its "power". For instance, you might have it set so that 100 units of energy are necessary for every 25 units of "power".</TD>
<TD>shieldpowerregenenergy=100;</TD>
</TR>
<TR>
<TD>ShieldRadius</TD>
<TD>Defines the size of the area the shield/repulsor protects. Can be set to any numerical value.</TD>
<TD>shieldradius=500;</TD>
</TR>
<TR>
<TD>ShieldRepulsor</TD>
<TD>If set to 1, the "shield"-type weapon will repulse projectiles. If set to 0, it will destroy them. Can be set to 1 or 0.</TD>
<TD>shieldrepulsor=1;</TD>
</TR>
<TR>
<TD>SmartShield</TD>
<TD>If set to 1, the shield/repulsor will not affect owned/allied weapons. Can be set to 1 or 0.</TD>
<TD>smartshield=1;</TD>
</TR>
<TR>
<TD>VisibleShield</TD>
<TD>If set to 1, the shield will be visible. Only for use on shield-type. Can be set to 1 or 0.</TD>
<TD>visibleshield=1;</TD>
</TR>
<TR>
<TD>VisibleShieldRepulse</TD>
<TD>If set to 1, the repulsing effect will be visible. Only for use on repulsor-type. Can be set to 1 or 0.</TD>
<TD>visibleshieldrepulse=1;</TD>
</TR>
</table>
</center>

[[category:Weapons]]

[[category:Shields]]

CEG-OldInfo

2007-09-24T05:23:14Z

ILMTitan: /* How to link a custom explosion to a weapon */

== 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.

For an exlplosion generator when a projectile bounces, there is also:
bounceexplosiongenerator = custom:ExplosionScriptName;

=== 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]]<br>
[[heatcloud]]<br>
[[smoke]]<br>
[[smoke2]]<br>
[[gfx]]<br>
[[bitmapmuzzleflame]]<br>
[[simpleparticlesystem]]<br>

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

<ul>

<li>
'''dir'''<br>
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>