Spring - User contributions [en]

Animation-CobConstants

2008-08-18T04:49:45Z

Evil4Zerggin: /* explode */

==Source==

This has a list of all COB SET/GET keys: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobInstance.cpp

You'll want to include a file with these constants in your script.

==SET/GET==

===Use===
Use GET [tag] to get a value. Some GETs refer to functions; in this case, use GET [tag](arg1, arg2, arg3, arg4).
Use SET [tag] to [value] to change a value.

===Tags===
There's a lot of GET/SET tags; I'll cover some of the more useful but less intuitive ones.

*ACTIVATION: Whether the unit is on (true) or off (false).
*ARMORED: When true, any damage dealt to the unit will be multiplied by its damageModifier.
*PRINT: You can use GET PRINT to send up to 4 arguments to chat. Useful for debugging.
*VETERAN_LEVEL: The unit's experience times 100. Note that you can SET this via script, although the unit won't gain any extra health from doing so.

==emit-sfx==

emit-sfx [sfxtype] from [piece];

The least significant byte of sfxtype is treated as an unsigned integer; the remaining bits are a bitmask. The bitmask indicates what ''type'' of sfx to emit, while the number indicates ''which'' sfx of that type to emit. The bits are as follows:

*256: Point-based fx. Used for white smoke (1), black smoke (2), and bubbles (3).
*1024: Unit sfx. Use with the unit's sfxtypes.explosionGenerators. The first one is 0, the second one is 1, etc.
*2048: Fire weapon. Fires a weapon from the piece (no aiming involved). Again, the first weapon is 0, the second weapon is 1, etc.
*4096: Explode weapon. Detonates a weapon at the piece. Again, the first weapon is 0, the second weapon is 1, etc.

==explode==

Causes the piece to explode and possibly go flying. This actually gives the appearance of making a copy of the piece (henceforth referred to as "debris") so if you're using it outside of Killed() you may want to hide the piece in question.

explode [piece] type [exptype];

exptype is a bitmask. The bits are as follows:

*SHATTER: Explodes the debris into tiny triangles. Looks like confetti.
*EXPLODE_ON_HIT: Debris will explode on impact, causing about 40 damage.
*FALL: Debris is affected by gravity.
*SMOKE
*FIRE
*BITMAPONLY: No debris, just an explosion graphic.
*NOCEGTRAIL
*BITMAP[1...5]: Doesn't actually appear to do anything.

Animation-CobConstants

2008-08-18T04:45:38Z

Evil4Zerggin: /* explode */

Lua:Main

2008-07-31T05:44:29Z

Evil4Zerggin:

'''Lua FAQ''' 
[[Lua_Beginners_FAQ]] 
[[:Category:Lua]] (shows which interfaces are loaded by LuaUI,LuaRules,etc.) 
[http://spring.clan-sy.com/phpbb/viewtopic.php?f=23&t=15596 Forum topic with some basic information about gadgets] 

'''Interfaces''' (last update: 76b1) 
{{LuaInterfaces}}
 
'''Other useful tables''' 
[[WeaponDefNames]]

[[UnitDefNames]]

'''Official Lua documentation''' 
[http://www.lua.org/pil/ 'Programming in Lua' book online] 
[http://www.lua.org/manual/5.1/ Lua 5.1 Reference manual] 
[http://lua-users.org/wiki/TutorialDirectory Lua tutorials]

'''old Wikis''' (outdated) 
[[Lua_SyncedInterface]] 
[[Units:LuaCOB]] 
[[Lua_Startscripts]]

Game and Unit development

2008-07-30T05:38:54Z

Evil4Zerggin: /* Units - FBI Files */

filehosting at 20080405:

http://www.tasdownloads.com/faq.php

http://spring.jobjol.nl/subcategory.php?id=1&language=English

http://spring-portal.com/

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*http://taspring.clan-sy.com/wiki/Create_units - old Wiki 
*[[Mod Development]]
*[[Mod specification]] 
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]

==Unit Development==
====Automated Mod Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring mods (requires a base modification for the game rules, XTA is recommended)
====Models - s3o Files====
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====Scripting and Animation - COB/BOS Files====
*[[COB_Overview]]
*[[COB_Animation]]
*[[COB_Callins]]
*[[COB_Constants]]
*[[COB_Threads]]
*[[COB_HitByWeaponID]]
*[[Image:Usa_flag.gif]][[Image:France_flag.gif]][[Units:.bos/.COB]] -all tags for make a animation file
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[http://www.tadesigners.com/bos1.htm TADesigners] have a nice tutorial too
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Image:France_flag.gif]] [[exemples de fichiers .fbi]]
*[[image:usa_flag.gif]][[ all tags & details with a exemple ]]
*[[Unit_Categories]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomExplosionGenerators|Mod Development:Custom explosions]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

Weapon Variables

2008-07-24T15:09:21Z

Evil4Zerggin: /* Descriptions */

=WeaponType=
This is a weapon tag! It allows you to bypass the engine's auto detection and force the weapontype. (example weaponType="StarburstLauncher")
<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>WeaponType</th><th> Description </th> </tr>
<TR>
<TD>AircraftBomb (dropped=1)</TD>
<TD>Drops a ballistic projectile (aka Plasma) at the same movement vector as the unit itself. It's only meant for planes. A plane that has a CBombDropper as its weapon1 is a bomber. The CBombDropper automatically calculates its burst and burstrate tags from its reload time and uses 5 as its reload time instead. It will fire if the first bomb would drop within a circle roughly unitspeed*burst*burstrate so the longer the burst and the faster the unit the larger the circle in which it will drop instead of not firing and hoping the next attack run will pass that circle.</TD>
</TR>
<TR>
<TD>StarburstLauncher(vlaunch=1)</TD>
<TD>Fires a projectile that rises vertically (starts with no velocity) for <weapontimer> seconds, then turns at a fixed rate towards its target. The projectile's lifetime depends on its range divided by its max speed (ignores acceleration) and the weapontimer somehow so the weapon can fall short depending on how these values are set. This is the only weapon that can properly perform intercepts and be interceptable. Emits a smoketrail.</TD>
</TR>
<TR>
<TD>BeamLaser (beamlaser=1)</TD>
<TD>Should be well known, this thing spawns a beam and does a portion of its total damage each frame. It can't have a burst or burstrate, it can't have collidefriendly=0, it can't be emit-sfxed if it has a beamtime longer than one frame and its damage decreases over range if the minIntensity=1 tag isn't used. The largebeamlaser tag allows changing the visual effect of the laser, doesn't affect the behaviour of the weapon itself in any way though. Beamlasers can be really annoying... BTW, their beam doesn't collide with water so if they're set to waterweapon=1 they can shoot normally even when underwater (won't shoot at underwater targets though).</TD>
</TR>
<TR>
<TD>Shield (isShield=1)</TD>
<TD>The shield. Really not much to say about this, the tags are all documented in the changelog.</TD>
</TR>
<TR>
<TD>TorpedoLauncher (waterweapon=1)</TD>
<TD>Fires a projectile that will behave ballistically out of water and like a missile in water. Since waterweapon=1 is usually set for them they can fire underwater and they will target underwater units. The torpedo is the only projectile that doesn't explode on the water surface. An aircraft carrying a TorpedoLauncher is a special case, the thing turns into a bomb dropepr that will spawn a torpedo projectile, probably to get the whole bomber flight behaviour. Note that the waterweapon tag is also used to make a weapon fire underwater, independent of its type.</TD>
</TR>
<TR>
<TD>DGun (weaponname contains the word "disintegrator")</TD>
<TD>This shoots a fireball that travels in a straight line. The fireball has no range limitation by itself so if it misses or is fired in FPS mode it will travel across the whole map and further. DGuns don't properly check their line of fire, if terrain is in the way they fire anyway. These things are meant to be used with noexplode=1 but of course you CAN use them without that, too. If ballistic=1 is set the fireball will be affected by gravity, the weapon won't compensate for it though so it will hit the ground before reaching the target. Might be useful for a Scorched Earth mod or something since you'd have to aim it manually to hit anything.</TD>
</TR>
<TR>
<TD>LightingCannon (sic) (lineofsight=1 and rendertype=7)</TD>
<TD>An instant hit weapon like the Beamlaser except with a lightning graphic and even more annoying. It won't damage shields and it has a hardcoded inaccuracy (comparable to targetMoveError, the code comment is "should make it weaker against air"...). Shares some of the weirdnesses with the beamlaser, e.g. being able to penetrate water.</TD>
</TR>
<TR>
<TD>LaserCannon (lineofsight=1 and either beamweapon=1 or weaponname contains "laser" (marked as "workaround for SWTA))</TD>
<TD>The OTA-style laser. Probably one of the least annoying weapons in the engine. Its length is defined by the duration tag (together with the speed), BTW.</TD>
</TR>
<TR>
<TD>MissileLauncher (lineofsight=1 and smoketrail=1)</TD>
<TD>Shoots a smoke-emitting projectile. It can use guidance, acceleration, etc. The projectile's lifetime depends on range/maxspeed so a slowly accelerating missile will fall short. It can also use trajectoryheight to have the shot arc but that has trouble with aiming at targets higher or lower than the shooter (see bug report, this REALLY could use some fixing). Pretty versatile weapon overall, if the laser rendering code was ported into this we could pretty much axe the LaserCannon completely.</TD>
</TR>
<TR>
<TD>EmgCannon (lineofsight=1 and rendertype=4 and color=2)</TD>
<TD>Few know about this, it's a line of sight (i.e. not ballistic) weapon that can use billboard rendering (looks like a sprite). No idea what drawbacks this has, noone ever uses it.</TD>
</TR>
<TR>
<TD>Flame (lineofsight=1 and rendertype=5)</TD>
<TD>The flamethrower. A really annoying weapon. AFAIK it won't even aim ahead of moving targets. Can't say much else about it since I haven't tried using it much but overall I'd avoid the weapontype and fake the effect somehow, it's not pretty when fast and won't hit jack when slow.</TD>
</TR>
<TR>
<TD>Cannon (anything that didn't trigger another weapon)</TD>
<TD>Aka plasma. Shoots a ballistic projectile. Unlike the DGun it aims properly. Can't be emit-sfxed properly, maybe a ballistic DGun can fill that role.</TD>
</TR>
<TR>
<TD>Melee (only reachable through WeaponType)</TD>
<TD>When it fires it simply damages the target, no ifs or buts. It doesn't use a projectile and doesn't care about the line of fire. It won't even report a proper heading and pitch to AimWeapon so if you plan on using it in 75b2 you have to slave it to another weapon to handle the aiming. May be useful to be the damage dealer for a cosmetic weapon, i.e. you slave the Melee to a weapon that does no damage but looks pretty and the Melee does the damage. Kinda like the weapons in Warcraft and so.</TD>
</TR>
<TR>
<TD>Rifle (only reachable through WeaponType)</TD>
<TD>An instant hit weapon but an apparently unmaintained one. It has a hardcoded firing and explosion effect. I wouldn't use it.</TD>
</TR>
<TR>
<TD>CNoWeapon (weaponname is NOWEAPON, not reachable by any tag)</TD>
<TD>Apparently a placeholder used when a weapon isn't present. It's not really a weapondef but generated when the unit demands a NOWEAPON.</TD></TR>
</table>

=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>AlwaysVisible</TD>
<TD>Ignore LOS handling and always draw the weapon effect? Can be 1 or 0.</TD>
<TD>alwaysVisible=0;</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>AvoidFeature</TD>
<TD>This makes the weapon avoid features while targetting (the shoot will still collide with features). Can be 1 or 0.</TD>
<TD>avoidFeature=0;</TD>
</TR>
<TR>
<TD>AvoidFriendly</TD>
<TD>If set to 0 units will not try to avoid friendly units in their line of fire. Can be 1 or 0.</TD>
<TD>avoidFriendly=1;</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>BeamDecay</TD>
<TD>For BeamLasers, defines the speed of the fadeout (each frame the beam's intensity is multiplied with that value). Can be between 0 and 1.</TD>
<TD>beamDecay=0.9;</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>BeamTTL</TD>
<TD>For BeamLasers, defines the time (in frames) the beam will stay after being fired. Can be any numeric value.</TD>
<TD>beamTtl=10;</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 when it reaches range the target was at when the weapon fired. Only works on plasma (rendertype=4) weapons and possibly missiles? 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>CameraShake</TD>
<TD>How much the camera shakes on impact. (needs the cameraShake widget to work). Can be any numeric value.</TD>
<TD>cameraShake=5;</TD>
</TR>
<TR>
<TD>CanAttackGround</TD>
<TD>Can be set to 1 or 0.</TD>
<TD>canAttackGround=0</TD>
</TR>
<TR>
<TD>CegTag</TD>
<TD>CegTag is the tag that emits a custom explosion every frame for a projectile. Can be used on any weapon to imitate dynamic lighting, smoke, fire, ball lightning, magic and many other things. Enter the name of your effect to make it emit once per frame.</TD>
<TD>cegtag=MISSILE_SMOKE_FX;</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>ColorMap</TD>
<TD>Only used by flamethrower. Must be a CColorMap type.</TD>
<TD>colorMap=1 0 0 1  0 1 0 1; (red to green fade)</TD>
</TR>
<TR>
<TD>CollideFriendly</TD>
<TD>If set to 0 this weapon will not hit friendly units. Can be set to 1 or 0.</TD>
<TD>collisionFriendly=1;</TD>
</TR>
<TR>
<TD>CollisionSize</TD>
<TD>Defines the physical size of projectiles, percentage of size for flamethrower and absolute value emg, plasma and laser. Can be any numeric value.</TD>
<TD>collisionSize=30;</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>CoreThickness</TD>
<TD>Thickness of the core of a laser (the part which use rgbcolor2). Can be any numeric value.</TD>
<TD>coreThickness=0.25;</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>CraterBoost</TD>
<TD>Adds a constant factor to the terraform the explosion does. Can be any numeric value. (default 0)</TD>
<TD>craterMult=0.1;</TD>
</TR>
<TR>
<TD>CraterMult</TD>
<TD>Multiplies with the terraform the explosion does. Can be any numeric value. (default :=impulsFactor)</TD>
<TD>craterMult=1.2;</TD>
</TR>
<TR>
<TD>CylinderTargetting</TD>
<TD>If greater than 0, range will be checked in a cylinder instead of a sphere:
half height=unitradius*cylinderTargetting
Defaults to 1 for Melee type weapons, 0 otherwise. In 0.76b1, does not work with BeamLaser weapons.([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image])</TD>
<TD>cylinderTargetting=0;</TD>
</TR>
<TR>
<TD>Dance</TD>
<TD>For missles, unlike wobble it doesn't rotate the missile and it prevents the missile from going too far off course so a dancing swarm will remain coherent. Can be any numeric value.</TD>
<TD>dance=97;</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. Also controls the length of the beam in BeamWeapon projectiles. Can be any numeric value. Used for rendertype 0 and 7 weapons.</TD>
<TD>duration=.5;</TD>
</TR>
<TR>
<TD>DynDamageExp</TD>
<TD>Exponent of the range damage formula, 0 (the default) disables dynamic damage. 1 means linear scaling. Only used by BeamLasers and LightingCannons. Can be any numeric value. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=263438#p263438 image])</TD>
<TD>dynDamageExp=0;</TD>
</TR>
<TR>
<TD>DynDamageInverted</TD>
<TD>Inverts the damage curve (more damage at far range). Only used by BeamLasers and LightingCannons. Can be 0 or 1.</TD>
<TD>dynDamageInverted=0;</TD>
</TR>
<TR>
<TD>DynDamageMin</TD>
<TD>Minimum dynamic range damage value. Only used by BeamLasers and LightingCannons. Can be any numeric value.</TD>
<TD>dynDamageMin=0;</TD>
</TR>
<TR>
<TD>DynDamageRange</TD>
<TD>If set it will use this value in the dynamic range damage formula instead of the range value from the weapon in the calculation. Only used by BeamLasers and LightingCannons. Can be any numeric value.</TD>
<TD>DynDamageRange=400;</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. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=251180#p251180 image])</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>ExplosionSpeed</TD>
<TD>Explosion animation speed/time. (only used by BeamLaser and LightingCannon?) default:
gd=max(30, DefaultDamage/20); 
expSpeed=(8+(gd*2.5))/(9+(sqrt(gd)*.7))/2; 
Can be any numeric value.
</TD>
<TD>explosionSpeed=5;</TD>
</TR>
<TR>
<TD>FallOffRate</TD>
<TD>Rate at which the beamweapon fades out after it goes past its maximum range. 0 is never fade out, 1 is finish fading out exactly at max range, the default 0.5 is the previous behaviour.
<TD>FallOffRate=0.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>FireSubmersed</TD>
<TD>If set the weapon can fire underwater, if not then not. Use it for weapons that cannot fire underwater but can hit underwater targets. Works even for torpedoes. Can be 0 or 1.</TD>
<TD>fireSubmersed=1;</TD>
</TR>
<TR>
<TD>FixedLauncher</TD>
<TD>For missiles, starburst missiles and torpedoes, this makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. The weapon will not properly check if allies are in the way so make sure you align the launchers in a way that won't hammer right into your own forces and perhaps use collideFriendly=0. FixedLauncher conflicts with trajectoryHeight and IMO combining them is pointless anyway so don't use both on a weapon. Can be 0 or 1.</TD>
<TD>fixedLauncher=0;</TD>
</TR>
<TR>
<TD>FlameGFXTime</TD>
<TD>Makes the flamethrower projectile stay alive as a graphical effect (doesnt do any damage) after it has reached maxrange. It is defined in percent, so 1.2 makes it remain 20% beyond maxrange. Can be any numeric value.
<TD>flamegfxtime=1.2;</TD>
</TR>
<TR>
<TD>FlightTime</TD>
<TD>Can be any numeric value.</TD>
<TD>flightTime=10;</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>HardStop</TD>
<TD>For LaserCannon, defined if the laser effect hard stops or fade out. Can be 0 or 1.</TD>
<TD>hardStop=0;</TD>
</TR>
<TR>
<TD>HeightBoostFactor</TD>
<TD>Gives control of cannon height range boost (more than 1 means increased range, 0 means the cannon has fixed range regardless of height difference to target. default is a magic value calculated on weapon init, based on range tag and theoretical max range.). Can be any numeric value, including negative ones (<0 := automatically calculated).</TD>
<TD>heightBoostFactor=-1;</TD>
</TR>
<TR>
<TD>HeightMod</TD>
<TD>Changes the sphere weapon range into an ellipsis. If it is larger 1.0 the weapon can't shoot as height as far, i.e. 0.5 means it can shoot twice as height as far ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image]). Note that this may not work well with beam weapons, use minIntensity (0..1) tag to fix that.</TD>
<TD>heightMod=1;</TD>
</TR>
<TR>
<TD>ImpulseBoost</TD>
<TD>A constant factor added on the weapon's impulsefactor. Can be any numeric value, including negative ones.</TD>
<TD>impulseBoost=0.5;</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>LargeBeamLaser</TD>
<TD>If set to 1 a beamlaser uses an alternate graphics effect. Can be 0 or 1.</TD>
<TD>largeBeamLaser=0;</TD>
</TR>
<TR>
<TD>LaserFlareSize</TD>
<TD>Size of the flare for laser weapons, multiplier for thickness. Can be set to any numeric value. (default: 15)</TD>
<TD>laserFlareSize=15;</TD>
</TR>
<TR>
<TD>Leadbonus</TD>
<TD>Is multiplied with the unit's experience and added to the lead limit.</TD>
<TD>leadbonus=1;</TD>
</TR>
<TR>
<TD>LeadLimit</TD>
<TD>Limits the maximum distance a unit will lead a target (default is -1 which means infinite).</TD>
<TD>leadLimit=1;</TD>
</TR>
<TR>
<TD>LineOfSight</TD>
<TD>NOT SUPPORTED BY SPRING! 
It is only used to detect the weapontype of ota weapon configs.</TD>
<TD></TD>
</TR>
<TR>
<TD>LodDistance</TD>
<TD>Minimum camera distance at which the default beamweapon projectile is simplified to rectangle. Can be set to any numeric value. (default: 1000)</TD>
<TD>lodDistance=1000;</TD>
</TR>
<TR>
<TD>ManualBombSettings</TD>
<TD>For Bombers, use burst and burstrate tags instead of hardcoded values. Can be set to 1 or 0.</TD>
<TD>manualBombSettings=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>MinIntensity</TD>
<TD>For beamlasers - always hit with some minimum intensity (a damage coeffcient normally dependent on distance - range 0 to 1). Can be set to any numeric value.</TD>
<TD>minIntensity=0.1;</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>MyGravity</TD>
<TD>For ballistic weapons (Cannon and Bomb), it overrides the map gravity if used. Regular map gravity is around 0.2.</TD>
<TD>myGravity=0.2;</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=10;</TD>
</TR>
<TR>
<TD>PredictBoost</TD>
<TD>No idea what it does. Default 0 for non-burnblow, 0.5 for burnblow weapons. Can be set to any numerical value.</TD>
<TD>predictBoost=15;</TD>
</TR>
<TR>
<TD>Projectiles</TD>
<TD>The weapon fires this many projectiles at once (shotgun style). Make sure you put them on different trajectories somehow (sprayangle or different firepoints) because otherwise they'll all be clumped in one shot. Works well combined with bursts. Can be set to any integer value.</TD>
<TD>projectiles=1o;</TD>
</TR>
<TR>
<TD>ProximityPriority</TD>
<TD>Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets. Can be set to any numerical value.</TD>
<TD>proximityPriority=1;</TD>
</TR>
<TR>
<TD>PulseSpeed</TD>
<TD>On LargeBeamLaser, how fast the pulsating effect at the beam start is. Can be set to any numerical value.</TD>
<TD>pulseSpeed=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>ScrollSeed</TD>
<TD>Only used by LargeBeamLaser. How fast the beam apears to be moving towards it target. Can be set to any numerical value.</TD>
<TD>scrollSeed=1;</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>Size</TD>
<TD>Defines the visible size of projectiles. Can be set to any numerical value. Default size is 2 + min(damage / 400, areaOfEffect / 10).</TD>
<TD>size=10;</TD>
</TR>
<TR>
<TD>SizeGrowth</TD>
<TD>Defines how fast flame projectiles will grow in size. Can be set to any numerical value.</TD>
<TD>sizegrowth=0.6;</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>SoundHitVolume</TD>
<TD>Can be any numerical value between 0 and 1.</TD>
<TD>soundhitvolume=0.5;</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>SoundStartVolume</TD>
<TD>Can be any numerical value between 0 and 1.</TD>
<TD>soundstartvolume=0.5;</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>SubMissile</TD>
<TD>For TorpedoLaunchers, if set to 1 the torpedo will travel like a missile outside of water. It will not emit a smoketrail, though. When fired from a plane it will behave the same way but the plane will probably be considered a fighter, not a bomber. Can be set to 1 or 0.</TD>
<TD>subMissile=0;</TD>
</TR>
<TR>
<TD>SweepFire</TD>
<TD>If 1 (default 0) it will make the weapon continue firing while it aims for a new target. Only works on continous beam lasers currently. Can be set to 1 or 0.</TD>
<TD>SweepFire=1;</TD>
</TR>
<TR>
<TD>TargeBorder</TD>
<TD>If nonzero, targetting units will TryTarget at the edge of collision sphere (radius*tag_value, [-1;1]) instead of its centre. Can be set between 0 and 1. Defaults to 1 for Melee type weapons, 0 otherwise. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image])</TD>
<TD>targetBorder=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>TileLength</TD>
<TD>Only used by LargeBeamLaser. Defines the length before the texture used is repeated (tiled).</TD>
<TD>tileLength=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>
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.
 

=Texture Tags=
<center>
<table width=500 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 1em; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th> Weapon </th><th> Used Texture Tags </th> </tr>
<TR>
<TD>AircraftBomb</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>texture1 = beam texture2 = beamend texture3 = flare </TD>
</TR>
<TR>
<TD>PlasmaCannon</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>EmgCannon</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>FlameThrower</TD>
<TD>texture1 = flame</TD>
</TR>
<TR>
<TD>LargeBeamLaser</TD>
<TD>texture1 = beam texture2 = beamend texture3 = muzzle texture4 = flare </TD>
</TR>
<TR>
<TD>LaserCannon</TD>
<TD>texture1 = beam texture2 = beamend </TD>
</TR>
<TR>
<TD>LightingCannon</TD>
<TD>texture1 = beam </TD>
</TR>
<TR>
<TD>MissileLauncher</TD>
<TD>texture1 = flare texture2 = smoketrail </TD>
</TR>
<TR>
<TD>Shield</TD>
<TD>texture1 = shield</TD>
</TR>
<TR>
<TD>StarburstLauncher</TD>
<TD>texture1 = flare texture2 = smoketrail texture3 = flame </TD>
</TR>
<TR>
<TD>TorpedoLauncher</TD>
<TD>texture1 = projectile </TD>
</TR>
</TABLE>
</center>
NOTE: All textures need to be `atlased`. So you have to define them in the '''resources.tdf''' and use the reference name in the texture tags.
 

=Plasma Visuals=
<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>AlphaDecay</TD>
<TD>How much a plasma particle is more transparent than the previous particle. Can be set to any numerical value. (default: 1)</TD>
<TD>AlphaDecay=0.95;</TD>
</TR>
<TR>
<TD>NoGap</TD>
<TD>If set to 1, the distance between plasma particles is proportional to the size of the two particles. If set to 0, the distance between plasma particles will be proportional to the size of the first particle.
Can be set to 1 or 0. (default: 1)</TD>
<TD>NoGap=0;</TD>
</TR>
<TR>
<TD>Separation</TD>
<TD>Distance between each plasma particle. Can be set to any number value. (default: 1)</TD>
<TD>Separation=5;</TD>
</TR>
<TR>
<TD>SizeDecay</TD>
<TD>How much a plasma particle is smaller than the previous within the same plasma shot. Can be set to any numerical value. (default: 0)</TD>
<TD>SizeDecay=0.2;</TD>
</TR>
<TR>
<TD>Stages</TD>
<TD>Number of particles used in one plasma shot. Can be set to any number value. (default: 5)</TD>
<TD>Stages=20;</TD>
</TR>
</table>
 

=Shield/Repulsor 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>ShieldStartingPower</TD>
<TD>If set the shield starts with this much power instead of 0. Can be set to any numerical value.</TD>
<TD>shieldStartingPower=100;</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>VisibleShieldHitFrames</TD>
<TD>Numbers of frames how long the shield should be visible after it got hit (the alpha value fades after the hit). Can be set to any numerical value. (default: 0 frames)</TD>
<TD>visibleShieldHitFrames=5;</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>


[[category:Weapons]]

[[category:Shields]]

Animation-CobCallins

2008-06-02T05:08:55Z

Evil4Zerggin:

==Source==

Some (but not all) are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Purpose==
Callins have two purposes:

First, they allow a script to be notified when an event happens, such as the unit being created or destroyed.

Second, they allow the engine to get information from the script. Sometimes this is accomplished through a return value, but usually this is done by setting one of the arguments to a function to the requested value.

==Callins==

===General===

*Create(): Called when the unit is created. "Created" means when the unit's nanoframe is created; if you want to wait until the unit is actually finished, you'll have to use something like

while(GET BUILD_PERCENT_LEFT) sleep 250;

*Activate()/Deactivate(): Called when the unit is turned on/off.
*Killed(severity, corpsetype): Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

*StartMoving()/StopMoving(): Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.
*SetSFXOccupy(terraintype): Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.
*MoveRate[0...3](): Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.
*SetDirection(heading): Used only for wind generators. Gives the direction of the wind.
*SetSpeed(speed): Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

*AimWeaponX(heading, pitch): Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).
*AimFromWeaponX(piecenum): You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.
*FireWeaponX(): Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).
*ShotX(): Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.
*QueryWeaponX(piecenum): You should set piecenum to a piece of the model. The shot starts from this piece of the model; this is called for this purpose after FireWeaponX() and ShotX(). LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips
*EndBurstX(): Called after the last shot in a burst.
*BlockShotX(unitID, block)
*TargetWeightX(unitID, weightMod)
*RockUnit(anglex, anglez): Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.
*HitByWeaponID(damage, weaponid?, unitid?): Called when the unit is hit by a weapon.
*SetMaxReloadTime(time): Called on unit creation. time is the time in ms that it takes the slowest-firing weapon to reload.

===Construction===

*StartBuilding(): Called when the unit starts building.
*StopBuilding(): Called when the unit stops building.
*QueryNanoPiece(piecenum): You should set piecenum to the piece you want the nanospray to come from.
*QueryBuildInfo(piecenum): For factories. You should set piecenum to the piece you want the unit to be built on.

===Transportation===
*Falling(): Used for airdropping units?
*Landed(): Used for airdropping units?
*QueryTransport(piecenum): You should set piecenum to the piece you want the transported unit to be attached to.
*BeginTransport(): Called when an air transport picks up a unit.
*EndTransport(): Called when an air transport becomes empty.
*TransportPickup(): Called when a land transport picks up a unit.
*TransportDrop(): Called when a land transport becomes empty.
*StartUnload(): Called when the transport starts the unloading process.

===Landing Pads===
*QueryLandingPadCount(count): You should set count to the number of landing pads. However, it doesn't seem to be actually necessary to do this unless you want more than 16 pads.
*QueryLandingPad(piecenum1, piecenum2, piecenum3...): Set each piecenum to a different landing pad piece.

Weapons:Antinukes

2008-05-29T21:32:41Z

Evil4Zerggin:

==What is an Antinuke?==

An antinuke is a stockpile, vlaunch, interceptor weapon. When it detects an enemy nuke launch targeted within its coverage radius, if it has at least one antinuke missile stockpiled, it launches one to intercept the nuke.

==Stockpile==

Currently all stockpile weapons have a hardcoded 2s reload time between shots (this is different than the stockpile time).

==Interception Basics==

Only one antinuke attempt will ever be made on a given nuke. If the antinuke misses, the nuke is home free.

The antinuke follows a pure pursuit course. That means it will attempt to turn toward the nuke's current position.

An antinuke will detonate a nuke by passing within twice its area of effect of the nuke. It can only detonate the nuke that it is targeted at.

The nuke and antinuke actually do explode, so if they are close to the ground when this happens, anything nearby will take damage.

Nuke and antinukes WILL collide with units. They will not collide with friendlies if you set collideFriendly to be false.

==Interception Success and Time==

===Distance===

The closer the nuke is to the antinuke, the shorter the time the antinuke has to intercept the nuke. However, the antinuke also has a better chance of catching the nuke when it is traveling slowly.

===areaOfEffect===
The greater the area of effect of the antinuke, the more tolerance it has for not meeting the nuke exactly.

===weaponTimer===
For vlaunch weapons, weaponTimer controls how long the missile will go upwards before turning towards its target; as such, it also affects the missile's maximum altitude. A short weaponTimer on an antinuke shortens the intercept time; a short weaponTimer on the nuke means that the antinuke has less time to intercept the nuke. Note that a very short weaponTimer on the antinuke can cause the interception to happen close to the nuke silo.

===turnRate===
Since the antinuke does not lead its target, a low turnRate can cause the antinuke to miss, especially if the nuke and/or antinuke is very fast. It has less of an effect on the nuke.

===weaponAcceleration===
vlaunch weapons continue accelerating after they turn towards their target.

===weaponVelocity===
If the antinuke is slower or not much faster than the nuke, it will be unlikely to intercept it if it misses on the initial pass.

Weapons:Antinukes

2008-05-29T21:29:09Z

Evil4Zerggin: New page: ==What is an Antinuke?== An antinuke is a stockpile, vlaunch, interceptor weapon. When it detects an enemy nuke launch targeted within its coverage radius, if it has at least one antinuke...

==What is an Antinuke?==

An antinuke is a stockpile, vlaunch, interceptor weapon. When it detects an enemy nuke launch targeted within its coverage radius, if it has at least one antinuke missile stockpiled, it launches one to intercept the nuke.

==Stockpile==

Currently all stockpile weapons have a hardcoded 2s reload time between shots (this is different than the stockpile time).

==Interception Basics==

Only one antinuke attempt will ever be made on a given nuke. If the antinuke misses, the nuke is home free.

The antinuke follows a pure pursuit course. That means it will attempt to turn toward the nuke's current position.

An antinuke will detonate a nuke by passing within twice its area of effect of the nuke. It can only detonate the nuke that it is targeted at.

The nuke and antinuke actually do explode, so if they are close to the ground when this happens, anything nearby will take damage.

==Interception Success and Time==

===Distance===

The closer the nuke is to the antinuke, the shorter the time the antinuke has to intercept the nuke. However, the antinuke also has a better chance of catching the nuke when it is traveling slowly.

===areaOfEffect===
The greater the area of effect of the antinuke, the more tolerance it has for not meeting the nuke exactly.

===weaponTimer===
For vlaunch weapons, weaponTimer controls how long the missile will go upwards before turning towards its target; as such, it also affects the missile's maximum altitude. A short weaponTimer on an antinuke shortens the intercept time; a short weaponTimer on the nuke means that the antinuke has less time to intercept the nuke. Note that a very short weaponTimer on the antinuke can cause the interception to happen close to the nuke silo.

===turnRate===
Since the antinuke does not lead its target, a low turnRate can cause the antinuke to miss, especially if the nuke and/or antinuke is very fast. It has less of an effect on the nuke.

===weaponAcceleration===
vlaunch weapons continue accelerating after they turn towards their target.

===weaponVelocity===
If the antinuke is slower or not much faster than the nuke, it will be unlikely to intercept it if it misses on the initial pass.

Game and Unit development

2008-05-29T21:10:57Z

Evil4Zerggin:

filehosting at 20080405:

http://www.tasdownloads.com/faq.php

http://spring.jobjol.nl/subcategory.php?id=1&language=English

http://spring-portal.com/

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*http://taspring.clan-sy.com/wiki/Create_units - old Wiki 
*[[Mod Development]]
*[[Mod specification]] 
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]

==Unit Development==
====Models - s3o Files====
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====Scripting and Animation - COB/BOS Files====
*[[COB_Overview]]
*[[COB_Animation]]
*[[COB_Callins]]
*[[COB_Constants]]
*[[COB_Threads]]
*[[Image:Usa_flag.gif]][[Image:France_flag.gif]][[Units:.bos/.COB]] -all tags for make a animation file
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[http://www.tadesigners.com/bos1.htm TADesigners] have a nice tutorial too
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Image:France_flag.gif]] [[exemples de fichiers .fbi]]
*[[image:usa_flag.gif]][[ all tags & details with a exemple ]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomExplosionGenerators|Mod Development:Custom explosions]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

Game and Unit development

2008-05-29T21:08:22Z

Evil4Zerggin:

filehosting at 20080405:

http://www.tasdownloads.com/faq.php

http://spring.jobjol.nl/subcategory.php?id=1&language=English

http://spring-portal.com/

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*http://taspring.clan-sy.com/wiki/Create_units - old Wiki 
*[[Mod Development]]
*[[Mod specification]] 
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]

==Unit Development==
====Models - s3o Files====
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====Scripting and Animation - COB/BOS Files====
*[[COB_Overview]]
*[[COB_Animation]]
*[[COB_Callins]]
*[[COB_Constants]]
*[[COB_Threads]]
*[[Image:Usa_flag.gif]][[Image:France_flag.gif]][[Units:.bos/.COB]] -all tags for make a animation file
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[http://www.tadesigners.com/bos1.htm TADesigners] have a nice tutorial too
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Image:France_flag.gif]] [[exemples de fichiers .fbi]]
*[[image:usa_flag.gif]][[ all tags & details with a exemple ]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapon_Interception]]: All about antinukes.

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomExplosionGenerators|Mod Development:Custom explosions]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

Game and Unit development

2008-05-29T21:07:14Z

Evil4Zerggin:

filehosting at 20080405:

http://www.tasdownloads.com/faq.php

http://spring.jobjol.nl/subcategory.php?id=1&language=English

http://spring-portal.com/

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*http://taspring.clan-sy.com/wiki/Create_units - old Wiki 
*[[Mod Development]]
*[[Mod specification]] 
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]

==Unit Development==
====Models - s3o Files====
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====Scripting and Animation - COB/BOS Files====
*[[COB]]
*[[COB_Overview]]
*[[COB_Animation]]
*[[COB_Callins]]
*[[COB_Constants]]
*[[COB_Threads]]
*[[Image:Usa_flag.gif]][[Image:France_flag.gif]][[Units:.bos/.COB]] -all tags for make a animation file
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[http://www.tadesigners.com/bos1.htm TADesigners] have a nice tutorial too
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Image:France_flag.gif]] [[exemples de fichiers .fbi]]
*[[image:usa_flag.gif]][[ all tags & details with a exemple ]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomExplosionGenerators|Mod Development:Custom explosions]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

Animation-CobCallins

2008-05-28T22:51:07Z

Evil4Zerggin:

==Source==

Some (but not all) are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Purpose==
Callins have two purposes:

First, they allow a script to be notified when an event happens, such as the unit being created or destroyed.

Second, they allow the engine to get information from the script. Sometimes this is accomplished through a return value, but usually this is done by setting one of the arguments to a function to the requested value.

==Callins==

===General===

*Create(): Called when the unit is created. "Created" means when the unit's nanoframe is created; if you want to wait until the unit is actually finished, you'll have to use something like

while(GET BUILD_PERCENT_LEFT) sleep 250;

*Activate()/Deactivate(): Called when the unit is turned on/off.
*Killed(severity, corpsetype): Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

*StartMoving()/StopMoving(): Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.
*SetSFXOccupy(terraintype): Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.
*MoveRate[0...3](): Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.
*SetDirection(heading): Used only for wind generators. Gives the direction of the wind.
*SetSpeed(speed): Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

*AimWeaponX(heading, pitch): Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).
*AimFromWeaponX(piecenum): You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.
*FireWeaponX(): Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).
*ShotX(): Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.
*QueryWeaponX(piecenum): You should set piecenum to a piece of the model. The shot starts from this piece of the model; this is called for this purpose after FireWeaponX() and ShotX(). LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips
*EndBurstX(): Called after the last shot in a burst.
*BlockShotX(unitID, block)
*TargetWeightX(unitID, weightMod)
*RockUnit(anglex, anglez): Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.
*HitByWeaponID(damage, weaponid?, unitid?)
*SetMaxReloadTime(time): Called on unit creation. time is the time in ms that it takes the slowest-firing weapon to reload.

===Construction===

*StartBuilding(): Called when the unit starts building.
*StopBuilding(): Called when the unit stops building.
*QueryNanoPiece(piecenum): You should set piecenum to the piece you want the nanospray to come from.
*QueryBuildInfo(piecenum): For factories. You should set piecenum to the piece you want the unit to be built on.

===Transportation===
*Falling(): Used for airdropping units?
*Landed(): Used for airdropping units?
*QueryTransport(piecenum): You should set piecenum to the piece you want the transported unit to be attached to.
*BeginTransport(): Called when an air transport picks up a unit.
*EndTransport(): Called when an air transport becomes empty.
*TransportPickup(): Called when a land transport picks up a unit.
*TransportDrop(): Called when a land transport becomes empty.
*StartUnload(): Called when the transport starts the unloading process.

===Landing Pads===
*QueryLandingPadCount(count): You should set count to the number of landing pads. However, it doesn't seem to be actually necessary to do this unless you want more than 16 pads.
*QueryLandingPad(piecenum1, piecenum2, piecenum3...): Set each piecenum to a different landing pad piece.

Animation-CobCallins

2008-05-28T22:23:37Z

Evil4Zerggin:

==Source==

Some (but not all) are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Purpose==
Callins have two purposes:

First, they allow a script to be notified when an event happens, such as the unit being created or destroyed.

Second, they allow the engine to get information from the script. Sometimes this is accomplished through a return value, but usually this is done by setting one of the arguments to a function to the requested value.

==Callins==

===General===

*Create(): Called when the unit is created. "Created" means when the unit's nanoframe is created; if you want to wait until the unit is actually finished, you'll have to use something like

while(GET BUILD_PERCENT_LEFT) sleep 250;

*Activate()/Deactivate(): Called when the unit is turned on/off.
*Killed(severity, corpsetype): Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

*StartMoving()/StopMoving(): Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.
*SetSFXOccupy(terraintype): Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.
*MoveRate[0...3](): Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.
*SetDirection(heading): Used only for wind generators. Gives the direction of the wind.
*SetSpeed(speed): Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

*AimWeaponX(heading, pitch): Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).
*AimFromWeaponX(piecenum): You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.
*FireWeaponX(): Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).
*ShotX(): Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.
*QueryWeaponX(piecenum): You should set piecenum to a piece of the model. The shot starts from this piece of the model; this is called for this purpose after FireWeaponX() and ShotX(). LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips
*EndBurstX(): Called after the last shot in a burst.
*BlockShotX()
*TargetWeightX()
*RockUnit(anglex, anglez): Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.
*HitByWeaponID(damage, weaponid?, unitid?)
*SetMaxReloadTime(time): Called on unit creation. time is the time in ms that it takes the slowest-firing weapon to reload.

===Construction===

*StartBuilding(): Called when the unit starts building.
*StopBuilding(): Called when the unit stops building.
*QueryNanoPiece(piecenum): You should set piecenum to the piece you want the nanospray to come from.
*QueryBuildInfo(piecenum): For factories. You should set piecenum to the piece you want the unit to be built on.

===Transportation===
*Falling(): Used for airdropping units?
*Landed(): Used for airdropping units?
*QueryTransport(piecenum): You should set piecenum to the piece you want the transported unit to be attached to.
*BeginTransport(): Called when an air transport picks up a unit.
*EndTransport(): Called when an air transport becomes empty.
*TransportPickup(): Called when a land transport picks up a unit.
*TransportDrop(): Called when a land transport becomes empty.
*StartUnload(): Called when the transport starts the unloading process.

===Landing Pads===
*QueryLandingPadCount(count): You should set count to the number of landing pads. However, it doesn't seem to be actually necessary to do this unless you want more than 16 pads.
*QueryLandingPad(piecenum1, piecenum2, piecenum3...): Set each piecenum to a different landing pad piece.

Animation-CobCallins

2008-05-28T22:16:38Z

Evil4Zerggin:

==Source==

Some (but not all) are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Purpose==
Callins have two purposes:

First, they allow a script to be notified when an event happens, such as the unit being created or destroyed.

Second, they allow the engine to get information from the script. Sometimes this is accomplished through a return value, but usually this is done by setting one of the arguments to a function to the requested value.

==Callins==

===General===

*Create(): Called when the unit is created. "Created" means when the unit's nanoframe is created; if you want to wait until the unit is actually finished, you'll have to use something like

while(GET BUILD_PERCENT_LEFT) sleep 250;

*Activate()/Deactivate(): Called when the unit is turned on/off.
*Killed(severity, corpsetype): Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

*StartMoving()/StopMoving(): Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.
*SetSFXOccupy(terraintype): Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.
*MoveRate[0...3](): Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.
*SetDirection(heading): Used only for wind generators. Gives the direction of the wind.
*SetSpeed(speed): Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

*AimWeaponX(heading, pitch): Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).
*AimFromWeaponX(piecenum): You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.
*FireWeaponX(): Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).
*ShotX(): Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.
*QueryWeaponX(piecenum): You should set piecenum to a piece of the model. The shot starts from this piece of the model; this is called for this purpose after FireWeaponX() and ShotX(). LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips
*EndBurstX(): Called after the last shot in a burst.
*BlockShotX()
*TargetWeightX()
*RockUnit(anglex, anglez): Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.
*HitByWeaponID(damage, weaponid?, unitid?)
*SetMaxReloadTime(time): Called on unit creation. time is the time in ms that it takes the slowest-firing weapon to reload.

===Construction===

*StartBuilding(): Called when the unit starts building.
*StopBuilding(): Called when the unit stops building.
*QueryNanoPiece(piecenum): You should set piecenum to the piece you want the nanospray to come from.
*QueryBuildInfo(piecenum): For factories. You should set piecenum to the piece you want the unit to be built on.

===Transportation===
*Falling(): Used for airdropping units?
*Landed(): Used for airdropping units?
*BeginTransport(): Called when the transport picks up a unit.
*QueryTransport(piecenum): You should set piecenum to the piece you want the transported unit to be attached to.
*TransportPickup()
*EndTransport(): Called when the transport becomes empty.
*StartUnload(): Called when the transport starts the unloading process.

===Landing Pads===
*QueryLandingPadCount(count): You should set count to the number of landing pads. However, it doesn't seem to be actually necessary to do this unless you want more than 16 pads.
*QueryLandingPad(piecenum1, piecenum2, piecenum3...): Set each piecenum to a different landing pad piece.

Animation-CobOverview

2008-05-28T05:49:57Z

Evil4Zerggin:

==What is COB?==

COB is the Spring engine's scripting system. Each unit has a .cob bitfile which defines many of its major behaviors, including animation and weapon aiming. Of course, COB is also capable of doing a lot more if you wish. When Spring is actually running, it interprets the bitfile for each unit as necessary. This interpreter runs in a very straightforward way, without any fancy optimizations, so don't expect great performance from it.

==BOS==

The code that gets compiled into a .cob is written in a .bos file. A program called Scriptor generally does this compilation. BOS uses a C-like syntax, although it has many Spring-specific features and isn't as powerful as C.

===BOS versus C===

Similarities:
*Function syntax. A function is defined by FunctionName(args).
*Block delimiters. Like C, a statement block is delimited by curly braces ({}).
*General syntax. For example, to add two variables and assign the result to a third, you say x = y + z;

Differences:
*Not case sensitive.
*Only one data type. There is only one type of data in COB, which is basically a 32-bit integer.
*Variable declaration.

You can declare a static variable, whose scope encompasses the entire script, using

static-var x;

You can declare multiple variables at once by separating them with commas.

Alternately, you can declare a local variable:

var x;

The scope is limited to the function that it is in.
*No pointers or arrays.
*No internal return values. When the script receives a callin, it may return a value to the "outside"; however, there is no way to return a value directly to another function within the script. You will have to use a static variable.
*Function calls.

Functions are called using

call-script Function(args);

or

start-script Function(args);

See [[COB_Threads]] for details.
*Multiple threads. This isn't as exciting as it sounds. Again, see [[COB_Threads]] for details.
*Spring-specific features. There are too many here to name; please consult the other COB articles.

Animation-CobOverview

2008-05-28T05:48:32Z

Evil4Zerggin:

==What is COB?==

COB is the Spring engine's scripting system. Each unit has a .cob bitfile which defines many of its major behaviors, including animation and weapon aiming. Of course, COB is also capable of doing a lot more if you wish. When Spring is actually running, it interprets the bitfile for each unit as necessary. This interpreter runs in a very straightforward way, without any fancy optimizations, so don't expect great performance from it.

==BOS==

The code that gets compiled into a .cob is written in a .bos file. A program called Scriptor generally does this compilation. BOS uses a C-like syntax, although it has many Spring-specific features and isn't as powerful as C.

===BOS versus C===

Similarities:
*Function syntax. A function is defined by FunctionName(args).
*Block delimiters. Like C, a statement block is delimited by curly braces ({}).
*General syntax. For example, to add two variables and assign the result to a third, you say x = y + z;

Differences:
*Not case sensitive.
*Only one data type. There is only one type of data in COB, which is basically a 32-bit integer.
*Variable declaration.

You can declare a static variable, whose scope encompasses the entire script, using

static-var x;

You can declare multiple variables at once by separating them with commas.

Alternately, you can declare a local variable:

var x;

The scope is limited to the function that it is in.
*No pointers or arrays.
*No internal return values. When the script receives a callin, it may return a value to the "outside"; however, there is no way to return a value directly to another function within the script. You will have to use a static variable.
*Function calls.

Functions are called using

call-script Function(args);

or

start-script Function(args);

See [[COB_Threads]] for details.
*Spring-specific features. There are too many here to name; please consult the other COB articles.

Animation-CobOverview

2008-05-28T05:47:08Z

Evil4Zerggin: New page: ==What is COB?== COB is the Spring engine's scripting system. Each unit has a .cob bitfile which defines many of its major behaviors, including animation and weapon aiming. Of course, COB...

==What is COB?==

COB is the Spring engine's scripting system. Each unit has a .cob bitfile which defines many of its major behaviors, including animation and weapon aiming. Of course, COB is also capable of doing a lot more if you wish. When Spring is actually running, it interprets the bitfile for each unit as necessary. This interpreter runs in a very straightforward way, without any fancy optimizations, so don't expect great performance from it.

==BOS==

The code that gets compiled into a .cob is written in a .bos file. A program called Scriptor generally does this compilation. BOS uses a C-like syntax, although it has many Spring-specific features and isn't as powerful as C.

===BOS versus C===

Similarities:
*Function syntax. A function is defined by FunctionName(args).
*Block delimiters. Like C, a statement block is delimited by curly braces ({}).
*General syntax. For example, to add two variables and assign the result to a third, you say x = y + z;

Differences:
*Only one data type. There is only one type of data in COB, which is basically a 32-bit integer.
*Variable declaration. You can declare a static variable, whose scope encompasses the entire script, using

static-var x;

You can declare multiple variables at once by separating them with commas.

Alternately, you can declare a local variable:

var x;

The scope is limited to the function that it is in.
*No pointers or arrays.
*No internal return values. When the script receives a callin, it may return a value to the "outside"; however, there is no way to return a value directly to another function within the script. You will have to use a static variable.
*Functions are called using

call-script Function(args);

or

start-script Function(args);

See [[COB_Threads]] for details.
*Spring-specific features. There are too many here to name; please consult the other COB articles.

Game and Unit development

2008-05-28T05:33:08Z

Evil4Zerggin:

filehosting at 20080405:

http://www.tasdownloads.com/faq.php

http://spring.jobjol.nl/subcategory.php?id=1&language=English

http://spring-portal.com/

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*http://taspring.clan-sy.com/wiki/Create_units - old Wiki 
*[[Mod Development]]
*[[Mod specification]] 
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]

==Unit Development==
====Models - s3o Files====
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====Scripting and Animation - COB/BOS Files====
*[[COB_Overview]]
*[[COB_Animation]]
*[[COB_Callins]]
*[[COB_Constants]]
*[[COB_Threads]]
*[[Image:Usa_flag.gif]][[Image:France_flag.gif]][[Units:.bos/.COB]] -all tags for make a animation file
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[http://www.tadesigners.com/bos1.htm TADesigners] have a nice tutorial too
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Image:France_flag.gif]] [[exemples de fichiers .fbi]]
*[[image:usa_flag.gif]][[ all tags & details with a exemple ]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomExplosionGenerators|Mod Development:Custom explosions]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

Animation-CobCallins

2008-05-28T05:32:14Z

Evil4Zerggin:

==Source==

Some (but not all) are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Callins==

===General===

*Create(): Called when the unit is created. "Created" means when the unit's nanoframe is created; if you want to wait until the unit is actually finished, you'll have to use something like

while(GET BUILD_PERCENT_LEFT) sleep 250;

*Activate()/Deactivate(): Called when the unit is turned on/off.
*Killed(severity, corpsetype): Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

*StartMoving()/StopMoving(): Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.
*SetSFXOccupy(terraintype): Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.
*MoveRate[0...3](): Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.
*SetDirection(heading): Used only for wind generators. Gives the direction of the wind.
*SetSpeed(speed): Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

*AimWeaponX(heading, pitch): Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).
*AimFromWeaponX(piecenum): You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.
*FireWeaponX(): Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).
*ShotX(): Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.
*QueryWeaponX(piecenum): You should set piecenum to a piece of the model. The shot starts from this piece of the model; this is called for this purpose after FireWeaponX() and ShotX(). LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips
*EndBurstX(): Called after the last shot in a burst.
*BlockShotX()
*TargetWeightX()
*RockUnit(anglex, anglez): Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.
*HitByWeaponID(damage, weaponid?, unitid?)

===Other===

*QueryLandingPadCount(count)
*QueryLandingPad
*Falling
*Landed
*SetMaxReloadTime(time): Called on unit creation. time is the time in ms that it takes the slowest-firing weapon to reload.
*BeginTransport
*QueryTransport
*TransportPickup
*EndTransport
*StartUnload
*StartBuilding(): Called when the unit starts building.
*StopBuilding(): Called when the unit stops building.
*QueryNanoPiece(piecenum): Set piecenum to the piece you want the nanospray to come from.
*QueryBuildInfo

Animation-CobAnimation

2008-05-28T05:22:45Z

Evil4Zerggin:

==Pieces==

Each unit has a root piece and a tree of other pieces attached to the root piece. At the top of each file you'll need to put the following line:

piece [names of pieces of the model separated by commas];

As usual, capitalization does not matter; neither does the order of the pieces. You do not need to name every piece that the model actually has, although you should do so, and you cannot do anything to a piece that you have not named. If you try to do something to a piece that doesn't exist, Spring will throw an error. Generally it will not crash but you'll probably get lots of chat spam, so avoid this.

Every piece starts in the position as it appears in any modeling program, such as Upspring. This is defined to be zero position and zero rotation.

Pieces are really numbers, although Scriptor usually throws a fit if you try to use them as numbers (it will not accept a number in places where it expects a piece name, although for functions that involve a piecenum you can use the piece's number instead of the piece name if you so desire). The first piece you list is 0, and it counts from there.

==Linear Units==

Everything linear ''really'' happens in a unit I'll call Spring distance (sd). This is a tiny distance--there are 216 = 65536 sd in an elmo, which is the unit that is most commonly used. For example, weapon ranges are specified in elmos. Fortunately, Scriptor can automatically convert elmos to sd: just put the number of elmos you want in brackets ([]). Sometimes you'll see scripts that use 2.5 * 216 = 163840 instead. I recommend not doing this since it makes conversion more difficult.

==Angular Units==

Likewise, everything angular ''really'' happens in a unit I'll call Spring angle (sa). There are 216 sa in a full circle. Generally you'll be working in degrees. There are 182 and 2/45 sa in a degree. Again, Scriptor can automatically convert from degrees to sa; just put the number of degrees you want in angles (<>).

==Axes==

All COB animation statements specify an axis. There are three axes, "x-axis", "y-axis", and "z-axis". Positive x is to the unit's left (the right if you are looking at the unit from the front). Positive y is to the unit's top. Positive z is to the unit's front.

The position and rotation of each piece defines the coordinate system for all of its child pieces. So, if you move or rotate a piece, all of its child pieces will move and rotate with it.

A positive angle is counterclockwise looking at the piece from the positive end of the axis toward the negative end of the axis.

==move==

move [piece] to [axis] [distance] now;

This moves the piece immediately. The piece will be in its new position along the axis before the next statement is executed.

move [piece] to [axis] [distance] speed [speed];

This moves the piece at some speed until it reaches its destination, or the piece is told to move to a different distance along the same axis, whichever comes first. After this statement, the piece moves independent of the script; indeed, the script proceeds immediately to the next statement after it sets the piece moving.

Speed is always positive, even if you are moving the piece to a negative distance. It is measured in Spring distance/second (sd/s).

wait-for-move [piece] along [axis];

Makes the thread sleep until the piece stops moving along the axis.

==turn==

These are similar to movement in behavior, except they rotate the piece.

turn [piece] to [axis] [angle] now;

Turns the piece to the specified angle around the axis immediately. The piece will be in its new rotation around the axis before the next statement is executed. Pieces rotate around their own center, not their parent's (although if the parent rotates, they do as well). If the piece moves, the center moves with it, so a piece's movement occurs "before" its rotation in determining its final position.

turn [piece] to [axis] [angle] speed [angular speed];

This turns the piece at some angular speed until it reaches its destination, or the piece is told to turn to a different distance around the same axis, whichever comes first. Angular speed is always positive, even if the angle is negative. The speed is in Spring angles/second (sa/s).

wait-for-turn [piece] around [axis];

Makes the thread sleep until the piece stops turning around the axis.

==spin==

spin [piece] around [axis] speed [angular speed];

This starts the piece spinning at a constant speed immediately. Again, the speed is in Spring angles/second (sa/s); however, it can be negative if you want it to spin in that direction.

spin [piece] around [axis] speed [angular speed] accelerate [angular acceleration];

The angular acceleration should always be positive, even if you are spinning the piece at a negative angular speed. It is measured in Spring angles per frame-second (sa/f*s); in other words, the speed of the piece will increase by that amount every ''frame'', not every second. There are 30 frames per second.

stop-spin [piece] around [axis];

Stops the piece from spinning immediately, regardless of its orientation.

stop-spin [piece] around [axis] decelerate [angular deceleration];

Slows the piece's spinning down until it stops. As with angular acceleration, the angular deceleration should always be positive and is measured in Spring angles per frame-second.

Animation-CobAnimation

2008-05-28T05:21:36Z

Evil4Zerggin:

==Pieces==

Each unit has a root piece and a tree of other pieces attached to the root piece. At the top of each file you'll need to put the following line:

piece [names of pieces of the model separated by commas];

As usual, capitalization does not matter; neither does the order of the pieces. You do not need to name every piece that the model actually has, although you should do so, and you cannot do anything to a piece that you have not named. If you try to do something to a piece that doesn't exist, Spring will throw an error. Generally it will not crash but you'll probably get lots of chat spam, so avoid this.

Every piece starts in the position as it appears in any modeling program, such as Upspring. This is defined to be zero position and zero rotation.

Pieces are really numbers, although Scriptor usually throws a fit if you try to use them as numbers (it will not accept a number in places where it expects a piece name, although for functions that involve a piecenum you can use the piece's number instead of the piece name if you so desire). The first piece you list is 0, and it counts from there.

==Linear Units==

Everything linear ''really'' happens in a unit I'll call Spring distance (sd). This is a tiny distance--there are 216 = 65536 sd in an elmo, which is the unit that is most commonly used. For example, weapon ranges are specified in elmos. Fortunately, Scriptor can automatically convert elmos to sd: just put the number of elmos you want in brackets. Sometimes you'll see scripts that use 2.5 * 216 = 163840 instead. I recommend not doing this since it makes conversion more difficult.

==Angular Units==

Likewise, everything angular ''really'' happens in a unit I'll call Spring angle (sa). There are 216 sa in a full circle. Generally you'll be working in degrees, and Scriptor can automatically convert from degrees to sa. There are 182 and 2/45 sa in a degree.

==Axes==

All COB animation statements specify an axis. There are three axes, "x-axis", "y-axis", and "z-axis". Positive x is to the unit's left (the right if you are looking at the unit from the front). Positive y is to the unit's top. Positive z is to the unit's front.

The position and rotation of each piece defines the coordinate system for all of its child pieces. So, if you move or rotate a piece, all of its child pieces will move and rotate with it.

A positive angle is counterclockwise looking at the piece from the positive end of the axis toward the negative end of the axis.

==move==

move [piece] to [axis] [distance] now;

This moves the piece immediately. The piece will be in its new position along the axis before the next statement is executed.

move [piece] to [axis] [distance] speed [speed];

This moves the piece at some speed until it reaches its destination, or the piece is told to move to a different distance along the same axis, whichever comes first. After this statement, the piece moves independent of the script; indeed, the script proceeds immediately to the next statement after it sets the piece moving.

Speed is always positive, even if you are moving the piece to a negative distance. It is measured in Spring distance/second (sd/s).

wait-for-move [piece] along [axis];

Makes the thread sleep until the piece stops moving along the axis.

==turn==

These are similar to movement in behavior, except they rotate the piece.

turn [piece] to [axis] [angle] now;

Turns the piece to the specified angle around the axis immediately. The piece will be in its new rotation around the axis before the next statement is executed. Pieces rotate around their own center, not their parent's (although if the parent rotates, they do as well). If the piece moves, the center moves with it, so a piece's movement occurs "before" its rotation in determining its final position.

turn [piece] to [axis] [angle] speed [angular speed];

This turns the piece at some angular speed until it reaches its destination, or the piece is told to turn to a different distance around the same axis, whichever comes first. Angular speed is always positive, even if the angle is negative. The speed is in Spring angles/second (sa/s).

wait-for-turn [piece] around [axis];

Makes the thread sleep until the piece stops turning around the axis.

==spin==

spin [piece] around [axis] speed [angular speed];

This starts the piece spinning at a constant speed immediately. Again, the speed is in Spring angles/second (sa/s); however, it can be negative if you want it to spin in that direction.

spin [piece] around [axis] speed [angular speed] accelerate [angular acceleration];

The angular acceleration should always be positive, even if you are spinning the piece at a negative angular speed. It is measured in Spring angles per frame-second (sa/f*s); in other words, the speed of the piece will increase by that amount every ''frame'', not every second. There are 30 frames per second.

stop-spin [piece] around [axis];

Stops the piece from spinning immediately, regardless of its orientation.

stop-spin [piece] around [axis] decelerate [angular deceleration];

Slows the piece's spinning down until it stops. As with angular acceleration, the angular deceleration should always be positive and is measured in Spring angles per frame-second.

Animation-CobCallins

2008-05-28T05:19:40Z

Evil4Zerggin:

==Source==

Some (but not all) are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Callins==

===General===

*Create(): Called when the unit is created (''not'' finished'').
*Activate()/Deactivate(): Called when the unit is turned on/off.
*Killed(severity, corpsetype): Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

*StartMoving()/StopMoving(): Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.
*SetSFXOccupy(terraintype): Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.
*MoveRate[0...3](): Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.
*SetDirection(heading): Used only for wind generators. Gives the direction of the wind.
*SetSpeed(speed): Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

*AimWeaponX(heading, pitch): Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).
*AimFromWeaponX(piecenum): You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.
*FireWeaponX(): Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).
*ShotX(): Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.
*QueryWeaponX(piecenum): You should set piecenum to a piece of the model. The shot starts from this piece of the model; this is called for this purpose after FireWeaponX() and ShotX(). LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips
*EndBurstX(): Called after the last shot in a burst.
*BlockShotX()
*TargetWeightX()
*RockUnit(anglex, anglez): Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.
*HitByWeaponID(damage, weaponid?, unitid?)

===Other===

*QueryLandingPadCount(count)
*QueryLandingPad
*Falling
*Landed
*SetMaxReloadTime(time): Called on unit creation. time is the time in ms that it takes the slowest-firing weapon to reload.
*BeginTransport
*QueryTransport
*TransportPickup
*EndTransport
*StartUnload
*StartBuilding(): Called when the unit starts building.
*StopBuilding(): Called when the unit stops building.
*QueryNanoPiece(piecenum): Set piecenum to the piece you want the nanospray to come from.
*QueryBuildInfo

Animation-CobCallins

2008-05-28T05:19:15Z

Evil4Zerggin:

==Source==

Some (but not all) are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Callins==

===General===

*Create(): Called when the unit is created (''not'' finished'').
*Activate()/Deactivate(): Called when the unit is turned on/off.
*Killed(severity, corpsetype): Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

*StartMoving()/StopMoving(): Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.
*SetSFXOccupy(terraintype): Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.
*MoveRate[0...3](): Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.
*SetDirection(heading): Used only for wind generators. Gives the direction of the wind.
*SetSpeed(speed): Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

*AimWeaponX(heading, pitch): Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).
*AimFromWeaponX(piecenum): You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.
*FireWeaponX(): Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).
*ShotX(): Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.
*QueryWeaponX(piecenum): You should set piecenum to a piece of the model. The shot starts from this piece of the model. LOS is also traced from here to the target to see if a weapon can fire; this is called for this purpose after FireWeaponX() and ShotX(). Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips
*EndBurstX(): Called after the last shot in a burst.
*BlockShotX()
*TargetWeightX()
*RockUnit(anglex, anglez): Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.
*HitByWeaponID(damage, weaponid?, unitid?)

===Other===

*QueryLandingPadCount(count)
*QueryLandingPad
*Falling
*Landed
*SetMaxReloadTime(time): Called on unit creation. time is the time in ms that it takes the slowest-firing weapon to reload.
*BeginTransport
*QueryTransport
*TransportPickup
*EndTransport
*StartUnload
*StartBuilding(): Called when the unit starts building.
*StopBuilding(): Called when the unit stops building.
*QueryNanoPiece(piecenum): Set piecenum to the piece you want the nanospray to come from.
*QueryBuildInfo

Animation-CobAnimation

2008-05-28T05:15:48Z

Evil4Zerggin:

==Pieces==

Each unit has a root piece and a tree of other pieces attached to the root piece. At the top of each file you'll need to put the following line:

piece [names of pieces of the model separated by commas];

As usual, capitalization does not matter; neither does the order of the pieces. You do not need to name every piece that the model actually has, although you should do so, and you cannot do anything to a piece that you have not named. If you try to do something to a piece that doesn't exist, Spring will throw an error. Generally it will not crash but you'll probably get lots of chat spam, so avoid this.

Every piece starts in the position as it appears in any modeling program, such as Upspring. This is defined to be zero position and zero rotation.

Pieces are really numbers, although Scriptor usually throws a fit if you try to use them as numbers (it will not accept a number in places where it expects a piece name, although for functions that involve a piecenum you can use the piece's number instead of the piece name if you so desire). The first piece you list is 0, and it counts from there.

==Linear Units==

Everything linear ''really'' happens in a unit I'll call Spring distance (sd). This is a tiny distance--there are 216 = 65536 sd in an elmo, which is the unit that is most commonly used. For example, weapon ranges are specified in elmos. Fortunately, Scriptor can automatically convert elmos to sd: just put the number of elmos you want in brackets. Sometimes you'll see scripts that use 2.5 * 216 = 163840 instead. I recommend not doing this since it makes conversion more difficult.

==Angular Units==

Likewise, everything angular ''really'' happens in a unit I'll call Spring angle (sa). There are 216 sa in a full circle. Generally you'll be working in degrees, and Scriptor can automatically convert from degrees to sa. There are 182 and 2/45 sa in a degree.

==Axes==

All COB animation statements specify an axis. There are three axes, "x-axis", "y-axis", and "z-axis". Positive x is to the unit's left (the right if you are looking at the unit from the front). Positive y is to the unit's top. Positive z is to the unit's front.

The position and rotation of each piece defines the coordinate system for all of its child pieces. So, if you move or rotate a piece, all of its child pieces will move and rotate with it.

A positive angle is counterclockwise looking at the piece from the positive end of the axis toward the negative end of the axis.

==move==

move [piece] to [axis] [distance] now;

This moves the piece immediately. The piece will be in its new position before the next statement is executed.

move [piece] to [axis] [distance] speed [speed];

This moves the piece at some speed until it reaches its destination, or the piece is told to move to a different distance along the same axis, whichever comes first. After this statement, the piece moves independent of the script; indeed, the script proceeds immediately to the next statement after it sets the piece moving.

Speed is always positive, even if you are moving the piece to a negative distance. It is measured in Spring distance/second (sd/s).

wait-for-move [piece] along [axis];

Makes the thread sleep until the piece stops moving along the axis.

==turn==

These are similar to movement in behavior, except they rotate the piece.

turn [piece] to [axis] [angle] now;

Turns the piece to the specified angle around the axis immediately. Pieces rotate around their own center, not their parent's (although if the parent rotates, they do as well). If the piece moves, the center moves with it, so a piece's movement occurs "before" its rotation in determining its final position.

turn [piece] to [axis] [angle] speed [angular speed];

Angular speed is always positive, even if the angle is negative. The speed is in Spring angles/second (sa/s).

wait-for-turn [piece] around [axis];

Makes the thread sleep until the piece stops spinning around the axis.

==spin==

spin [piece] around [axis] speed [angular speed];

This starts the piece spinning at a constant speed immediately. Again, the speed is in Spring angles/second (sa/s); however, it can be negative if you want it to spin in that direction.

spin [piece] around [axis] speed [angular speed] accelerate [angular acceleration];

The angular acceleration should always be positive, even if you are spinning the piece at a negative angular speed. It is measured in Spring angles per frame-second (sa/f*s); in other words, the speed of the piece will increase by that amount every ''frame'', not every second. There are 30 frames per second.

stop-spin [piece] around [axis];

Stops the piece from spinning immediately, regardless of its orientation.

stop-spin [piece] around [axis] decelerate [angular deceleration];

Slows the piece's spinning down until it stops. As with angular acceleration, the angular deceleration should always be positive and is measured in Spring angles per frame-second.

Animation-CobAnimation

2008-05-28T05:15:04Z

Evil4Zerggin:

==Pieces==

Each unit has a root piece and a tree of other pieces attached to the root piece. At the top of each file you'll need to put the following line:

piece [names of pieces of the model separated by commas];

As usual, capitalization does not matter; neither does the order of the pieces. You do not need to name every piece that the model actually has, although you should do so, and you cannot do anything to a piece that you have not named. If you try to do something to a piece that doesn't exist, Spring will throw an error. Generally it will not crash but you'll probably get lots of chat spam, so avoid this.

Every piece starts in the position as it appears in any modeling program, such as Upspring. This is defined to be zero position and zero rotation.

Pieces are really numbers, although Scriptor usually throws a fit if you try to use them as numbers (it will not accept a number in places where it expects a piece name, although for functions that involve a piecenum you can use the piece's number instead of the piece name if you so desire). The first piece you list is 0, and it counts from there.

==Linear Units==

Everything linear ''really'' happens in a unit I'll call Spring distance (sd). This is a tiny distance--there are 2^16 = 65536 sd in an elmo, which is the unit that is most commonly used. For example, weapon ranges are specified in elmos. Fortunately, Scriptor can automatically convert elmos to sd: just put the number of elmos you want in brackets. Sometimes you'll see scripts that use 2.5*2^16 = 163840 instead. I recommend not doing this since it makes conversion more difficult.

==Angular Units==

Likewise, everything angular ''really'' happens in a unit I'll call Spring angle (sa). There are 2^16 sa in a full circle. Generally you'll be working in degrees, and Scriptor can automatically convert from degrees to sa. There are 182 and 2/45 sa in a degree.

==Axes==

All COB animation statements specify an axis. There are three axes, "x-axis", "y-axis", and "z-axis". Positive x is to the unit's left (the right if you are looking at the unit from the front). Positive y is to the unit's top. Positive z is to the unit's front.

The position and rotation of each piece defines the coordinate system for all of its child pieces. So, if you move or rotate a piece, all of its child pieces will move and rotate with it.

A positive angle is counterclockwise looking at the piece from the positive end of the axis toward the negative end of the axis.

==move==

move [piece] to [axis] [distance] now;

This moves the piece immediately. The piece will be in its new position before the next statement is executed.

move [piece] to [axis] [distance] speed [speed];

This moves the piece at some speed until it reaches its destination, or the piece is told to move to a different distance along the same axis, whichever comes first. After this statement, the piece moves independent of the script; indeed, the script proceeds immediately to the next statement after it sets the piece moving.

Speed is always positive, even if you are moving the piece to a negative distance. It is measured in Spring distance/second (sd/s).

wait-for-move [piece] along [axis];

Makes the thread sleep until the piece stops moving along the axis.

==turn==

These are similar to movement in behavior, except they rotate the piece.

turn [piece] to [axis] [angle] now;

Turns the piece to the specified angle around the axis immediately. Pieces rotate around their own center, not their parent's (although if the parent rotates, they do as well). If the piece moves, the center moves with it, so a piece's movement occurs "before" its rotation in determining its final position.

turn [piece] to [axis] [angle] speed [angular speed];

Angular speed is always positive, even if the angle is negative. The speed is in Spring angles/second (sa/s).

wait-for-turn [piece] around [axis];

Makes the thread sleep until the piece stops spinning around the axis.

==spin==

spin [piece] around [axis] speed [angular speed];

This starts the piece spinning at a constant speed immediately. Again, the speed is in Spring angles/second (sa/s); however, it can be negative if you want it to spin in that direction.

spin [piece] around [axis] speed [angular speed] accelerate [angular acceleration];

The angular acceleration should always be positive, even if you are spinning the piece at a negative angular speed. It is measured in Spring angles per frame-second (sa/f*s); in other words, the speed of the piece will increase by that amount every ''frame'', not every second. There are 30 frames per second.

stop-spin [piece] around [axis];

Stops the piece from spinning immediately, regardless of its orientation.

stop-spin [piece] around [axis] decelerate [angular deceleration];

Slows the piece's spinning down until it stops. As with angular acceleration, the angular deceleration should always be positive and is measured in Spring angles per frame-second.

Animation-CobAnimation

2008-05-28T05:01:53Z

Evil4Zerggin:

==Pieces==

Each unit will have a root piece, and then a tree of other pieces attached to the root piece. At the top of each file you'll need to put the following line:

piece [names of pieces of the model separated by commas];

As usual, capitalization does not matter. You do not need to name every piece that the model actually has, although you should do so, and you cannot do anything to a piece that you have not named. If you try to do something to a piece that doesn't exist, Spring will throw an error. Generally it will not crash but you'll probably get lots of chat spam, so avoid this.

Every piece starts in the position as it appears in any modeling program, such as Upspring. This is defined to be zero position and zero rotation.

==Linear Units==

Everything linear ''really'' happens in a unit I'll call Spring distance (sd). This is a tiny distance--there are 2^16 = 65536 sd in an elmo, which is the unit that is most commonly used. For example, weapon ranges are specified in elmos. Fortunately, Scriptor can automatically convert elmos to sd: just put the number of elmos you want in brackets. Sometimes you'll see scripts that use 2.5*2^16 = 163840 instead. I recommend not doing this since it makes conversion more difficult.

==Angular Units==

Likewise, everything angular ''really'' happens in a unit I'll call Spring angle (sa). There are 2^16 sa in a full circle. Generally you'll be working in degrees, and Scriptor can automatically convert from degrees to sa. There are 182 and 2/45 sa in a degree.

==Axes==

All COB animation statements specify an axis. There are three axes, "x-axis", "y-axis", and "z-axis". Positive x is to the unit's left (the right if you are looking at the unit from the front). Positive y is to the unit's top. Positive z is to the unit's front.

The position and rotation of each piece defines the coordinate system for all of its child pieces. So, if you move or rotate a piece, all of its child pieces will move and rotate with it.

==move==

move [piece] to [axis] [distance] now;

This moves the piece immediately. The piece will be in its new position before the next statement is executed.

move [piece] to [axis] [distance] speed [speed];

This moves the piece at some speed until it reaches its destination, or the piece is told to move to a different distance along the same axis, whichever comes first. After this statement, the piece moves independent of the script; indeed, the script proceeds immediately to the next statement after it sets the piece moving.

Speed is always positive, even if you are moving the piece to a negative distance. It is measured in Spring distance/second (sd/s).

wait-for-move [piece] along [axis];

Makes the thread sleep until the piece stops moving.

==turn==

These are similar to movement in behavior, except they rotate the piece.

turn [piece] to [axis] [angle] now;

turn [piece] to [axis] [angle] speed [angular speed];

Pieces rotate around their __own__ center, not their parent's. If the piece moves, the center moves with it. A positive angle is counterclockwise looking at the piece from the positive end of the axis toward the negative end. Angular speed is always positive, even if the angle is negative. The speed is measured in Spring angles/second (sa/s).

wait-for-turn [piece] around [axis];

==spin==

spin [piece] around [axis]

Animation-CobAnimation

2008-05-28T04:45:25Z

Evil4Zerggin: New page: ==Linear Units== Everything linear ''really'' happens in a unit I'll call Spring distance (sd). This is a tiny distance--there are 2^16 = 65536 sd in an elmo, which is the unit that is mo...

==Linear Units==

Everything linear ''really'' happens in a unit I'll call Spring distance (sd). This is a tiny distance--there are 2^16 = 65536 sd in an elmo, which is the unit that is most commonly used. For example, weapon ranges are specified in elmos. Fortunately, Scriptor can automatically convert elmos to sd: just put the number of elmos you want in brackets. Sometimes you'll see scripts that use 2.5*2^16 = 163840 instead. I recommend not doing this since it makes conversion more difficult.

==Angular Units==

Likewise, everything angular ''really'' happens in a unit I'll call Spring angle (sa). There are 2^16 sa in a full circle. Generally you'll be working in degrees, and Scriptor can automatically convert from degrees to sa. There are 182 and 2/45 sa in a degree.

==Axes==

All COB animation statements specify an axis. There are three axes, "x-axis", "y-axis", and "z-axis". Positive x is to the unit's left (the right if you are looking at the unit from the front). Positive y is to the unit's top. Positive z is to the unit's front.

==turn==

turn [piece] to [axis] now;

or

turn [piece] to [axis] speed [speed]

Game and Unit development

2008-05-28T04:34:57Z

Evil4Zerggin:

filehosting at 20080405:

http://www.tasdownloads.com/faq.php

http://spring.jobjol.nl/subcategory.php?id=1&language=English

http://spring-portal.com/

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*http://taspring.clan-sy.com/wiki/Create_units - old Wiki 
*[[Mod Development]]
*[[Mod specification]] 
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]

==Unit Development==
====Models - s3o Files====
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====Scripting and Animation - COB/BOS Files====
*[[COB_Animation]]
*[[COB_Callins]]
*[[COB_Constants]]
*[[COB_Threads]]
*[[Image:Usa_flag.gif]][[Image:France_flag.gif]][[Units:.bos/.COB]] -all tags for make a animation file
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[http://www.tadesigners.com/bos1.htm TADesigners] have a nice tutorial too
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Image:France_flag.gif]] [[exemples de fichiers .fbi]]
*[[image:usa_flag.gif]][[ all tags & details with a exemple ]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomExplosionGenerators|Mod Development:Custom explosions]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

Animation-CobThreads

2008-05-27T23:04:27Z

Evil4Zerggin:

==Source==

https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobThread.cpp

==Introduction==

Much of the time you can expect your script to execute sequentially; that is, looking through your code, the system progresses from statement to statement without anything "strange" (variables being changed, threads being started, etc.) between them. HOWEVER, "strange" things do happen, and in fact they happen quite regularly in scripts. We say that the script system has "concurrency" when things can happen between statements.

===Why Concurrency?===
So why go to all this trouble with concurrency? The script system has concurrency because we never know when things are going to happen. The player could give a command to the unit, the unit could run into a wall, rocks could fall out of the sky and kill the unit, and so forth. Without concurrency we would have to check very often whether which of all possible events had happened recently in order to determine what to do next. This would suck.

==Dealing With Concurrency==
Every time a callin is called or a start-script statement is executed, a "thread" is created. At any one time, only one thread is being executed at a time, but sometimes a thread will stop executing for a while and continue later, while several other threads will execute in the meantime. Most of the time your script is guaranteed to execute sequentially. If you say x = 1;, it will stay 1 unless you change it again. The exceptions are as follows:

*Before a script starts.
*After a wait-for-move or wait-for-turn statement.
*After a sleep statement.

During these times, any other thread has the ability to come in and change all your static variables, tell your pieces to move, turn, and spin, and so forth. Therefore, you cannot always assume these things will be the way you left them when execution of the thread resumes. If it is possible that another thread will change something that you need to know about, you need to check it after any of these times.

==Sleeping==

You can have a thread sleep by using a sleep statement:

sleep [time in ms];

This is useful for delaying events and in making loops execute every so often. If you want to wait until a piece moves into position, use wait-for-move or wait-for-turn instead.

==Signals==

Signals provide a way to kill threads in their sleep. Signals are bitmasks. There are two statement types dealing with signals: signal and set-signal-mask.

signal [bitmask];

kills all sleeping threads that overlap the bitmask.

set-signal-mask [bitmask];

sets what signals kill the current thread.

This has several applications. For functions that are called regularly, such as AimWeaponX(), this prevents multiple copies of the same thread from running at the same time. It is also a way (but not the only or necessarily best way) to interrupt another thread.

==call-script==

Use as follows:

call-script [function]([args]);

This does not start a new thread! The calling function will not continue until the called function returns.

==start-script==

At first glance, this is similar to call-script:

start-script [function]([args]);

However, start-script ''does'' create a new thread, and the calling function ''doesn't'' wait until the started function returns before continuing. By default, the new thread shares the same signal mask as its parent, although you can set it manually if you like. Apart from this, the two threads execute completely independently.

Animation-CobConstants

2008-05-27T23:04:12Z

Evil4Zerggin:

==Source==

This has a list of all COB SET/GET keys: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobInstance.cpp

You'll want to include a file with these constants in your script.

==SET/GET==

===Use===
Use GET [tag] to get a value. Some GETs refer to functions; in this case, use GET [tag](arg1, arg2, arg3, arg4).
Use SET [tag] to [value] to change a value.

===Tags===
There's a lot of GET/SET tags; I'll cover some of the more useful but less intuitive ones.

*ACTIVATION: Whether the unit is on (true) or off (false).
*ARMORED: When true, any damage dealt to the unit will be multiplied by its damageModifier.
*PRINT: You can use GET PRINT to send up to 4 arguments to chat. Useful for debugging.
*VETERAN_LEVEL: The unit's experience times 100. Note that you can SET this via script, although the unit won't gain any extra health from doing so.

==emit-sfx==

emit-sfx [sfxtype] from [piece];

The least significant byte of sfxtype is treated as an unsigned integer; the remaining bits are a bitmask. The bitmask indicates what ''type'' of sfx to emit, while the number indicates ''which'' sfx of that type to emit. The bits are as follows:

*256: Point-based fx. Used for white smoke (1), black smoke (2), and bubbles (3).
*1024: Unit sfx. Use with the unit's sfxtypes.explosionGenerators. The first one is 0, the second one is 1, etc.
*2048: Fire weapon. Fires a weapon from the piece (no aiming involved). Again, the first weapon is 0, the second weapon is 1, etc.
*4096: Explode weapon. Detonates a weapon at the piece. Again, the first weapon is 0, the second weapon is 1, etc.

==explode==

Causes the piece to explode and possibly go flying. This actually gives the appearance of making a copy of the piece (henceforth referred to as "debris" so if you're using it outside of Killed() you may want to hide the piece in question.

explode [piece] type [exptype];

exptype is a bitmask. The bits are as follows:

*SHATTER: Explodes the debris into tiny triangles. Looks like confetti.
*EXPLODE_ON_HIT: Debris will explode on impact, causing about 40 damage.
*FALL: Debris is affected by gravity.
*SMOKE
*FIRE
*BITMAPONLY: No debris, just an explosion graphic.
*NOCEGTRAIL
*BITMAP[1...5]

Animation-CobCallins

2008-05-27T23:03:11Z

Evil4Zerggin:

==Source==

Some (but not all) are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Callins==

===General===

*Create(): Called when the unit is created (''not'' finished'').
*Activate()/Deactivate(): Called when the unit is turned on/off.
*Killed(severity, corpsetype): Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

*StartMoving()/StopMoving(): Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.
*SetSFXOccupy(terraintype): Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.
*MoveRate[0...3](): Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.
*SetDirection(heading): Used only for wind generators. Gives the direction of the wind.
*SetSpeed(speed): Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

*AimWeaponX(heading, pitch): Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).
*AimFromWeaponX(piecenum): You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.
*QueryWeaponX(piecenum): You should set piecenum to a piece of the model. The shot starts from this piece of the model. LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips
*FireWeaponX(): Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).
*ShotX(): Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.
*EndBurstX(): Called after the last shot in a burst.
*BlockShotX()
*TargetWeightX()
*RockUnit(anglex, anglez): Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.
*HitByWeaponID(damage, weaponid?, unitid?)

===Other===

*QueryLandingPadCount(count)
*QueryLandingPad
*Falling
*Landed
*SetMaxReloadTime(time): Called on unit creation. time is the time in ms that it takes the slowest-firing weapon to reload.
*BeginTransport
*QueryTransport
*TransportPickup
*EndTransport
*StartUnload
*StartBuilding(): Called when the unit starts building.
*StopBuilding(): Called when the unit stops building.
*QueryNanoPiece(piecenum): Set piecenum to the piece you want the nanospray to come from.
*QueryBuildInfo

Animation-CobCallins

2008-05-27T23:01:45Z

Evil4Zerggin:

==Source==

Some (but not all) are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Callins==

===General===

Create(): Called when the unit is created (''not'' finished'').
Activate()/Deactivate(): Called when the unit is turned on/off.
Killed(severity, corpsetype): Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

StartMoving()/StopMoving(): Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.
SetSFXOccupy(terraintype): Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.
MoveRate[0...3](): Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.
SetDirection(heading): Used only for wind generators. Gives the direction of the wind.
SetSpeed(speed): Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

AimWeaponX(heading, pitch): Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).
AimFromWeaponX(piecenum): You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.
QueryWeaponX(piecenum): You should set piecenum to a piece of the model. The shot starts from this piece of the model. LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips
FireWeaponX(): Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).
ShotX(): Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.
EndBurstX(): Called after the last shot in a burst.
BlockShotX()
TargetWeightX()
RockUnit(anglex, anglez): Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.
HitByWeaponID(damage, weaponid?, unitid?)

===Other===

QueryLandingPadCount(count)
QueryLandingPad
Falling
Landed
SetMaxReloadTime(time): Called on unit creation. time is the time in ms that it takes the slowest-firing weapon to reload.
BeginTransport
QueryTransport
TransportPickup
EndTransport
StartUnload
StartBuilding(): Called when the unit starts building.
StopBuilding(): Called when the unit stops building.
QueryNanoPiece(piecenum): Set piecenum to the piece you want the nanospray to come from.
QueryBuildInfo

Animation-CobConstants

2008-05-27T22:46:04Z

Evil4Zerggin:

==Source==

This has a list of all COB SET/GET keys: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobInstance.cpp

You'll want to include a file with these constants in your script.

==SET/GET==

===Use===
Use GET [tag] to get a value. Some GETs refer to functions; in this case, use GET [tag](arg1, arg2, arg3, arg4).
Use SET [tag] to [value] to change a value.

===Tags===
There's a lot of GET/SET tags; I'll cover some of the more useful but less intuitive ones.

ACTIVATION: Whether the unit is on (true) or off (false).
ARMORED: When true, any damage dealt to the unit will be multiplied by its damageModifier.
PRINT: You can use GET PRINT to send up to 4 arguments to chat. Useful for debugging.
VETERAN_LEVEL: The unit's experience times 100. Note that you can SET this via script, although the unit won't gain any extra health from doing so.

==emit-sfx==

emit-sfx [sfxtype] from [piece];

The least significant byte of sfxtype is treated as an unsigned integer; the remaining bits are a bitmask. The bitmask indicates what ''type'' of sfx to emit, while the number indicates ''which'' sfx of that type to emit. The bits are as follows:

256: Point-based fx. Used for white smoke (1), black smoke (2), and bubbles (3).
1024: Unit sfx. Use with the unit's sfxtypes.explosionGenerators. The first one is 0, the second one is 1, etc.
2048: Fire weapon. Fires a weapon from the piece (no aiming involved). Again, the first weapon is 0, the second weapon is 1, etc.
4096: Explode weapon. Detonates a weapon at the piece. Again, the first weapon is 0, the second weapon is 1, etc.

==explode==

Causes the piece to explode and possibly go flying. This actually gives the appearance of making a copy of the piece (henceforth referred to as "debris" so if you're using it outside of Killed() you may want to hide the piece in question.

explode [piece] type [exptype];

exptype is a bitmask. The bits are as follows:

SHATTER: Explodes the debris into tiny triangles. Looks like confetti.
EXPLODE_ON_HIT: Debris will explode on impact, causing about 40 damage.
FALL: Debris is affected by gravity.
SMOKE
FIRE
BITMAPONLY: No debris, just an explosion graphic.
NOCEGTRAIL
BITMAP[1...5]

Animation-CobConstants

2008-05-27T22:45:34Z

Evil4Zerggin:

==Source==

This has a list of all COB SET/GET keys: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobInstance.cpp

You'll want to include a file with these constants in your script.

==SET/GET==

===Use===
Use GET [tag] to get a value. Some GETs refer to functions; in this case, use GET [tag](arg1, arg2, arg3, arg4).
Use SET [tag] to [value] to change a value.

===Tags===
There's a lot of GET/SET tags; I'll cover some of the more useful but less intuitive ones.

ACTIVATION: Whether the unit is on (true) or off (false).

ARMORED: When true, any damage dealt to the unit will be multiplied by its damageModifier.

PRINT: You can use GET PRINT to send up to 4 arguments to chat. Useful for debugging.

VETERAN_LEVEL: The unit's experience times 100. Note that you can SET this via script, although the unit won't gain any extra health from doing so.

==emit-sfx==

emit-sfx [sfxtype] from [piece];

The least significant byte of sfxtype is treated as an unsigned integer; the remaining bits are a bitmask. The bitmask indicates what ''type'' of sfx to emit, while the number indicates ''which'' sfx of that type to emit. The bits are as follows:

256: Point-based fx. Used for white smoke (1), black smoke (2), and bubbles (3).
1024: Unit sfx. Use with the unit's sfxtypes.explosionGenerators. The first one is 0, the second one is 1, etc.
2048: Fire weapon. Fires a weapon from the piece (no aiming involved). Again, the first weapon is 0, the second weapon is 1, etc.
4096: Explode weapon. Detonates a weapon at the piece. Again, the first weapon is 0, the second weapon is 1, etc.

==explode==

Causes the piece to explode and possibly go flying. This actually gives the appearance of making a copy of the piece (henceforth referred to as "debris" so if you're using it outside of Killed() you may want to hide the piece in question.

explode [piece] type [exptype];

exptype is a bitmask. The bits are as follows:

SHATTER: Explodes the debris into tiny triangles. Looks like confetti.
EXPLODE_ON_HIT: Debris will explode on impact, causing about 40 damage.
FALL: Debris is affected by gravity.
SMOKE
FIRE
BITMAPONLY: No debris, just an explosion graphic.
NOCEGTRAIL
BITMAP[1...5]

Animation-CobThreads

2008-05-27T22:19:33Z

Evil4Zerggin:

==Source==

https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobThread.cpp

==Introduction==

Much of the time you can expect your script to execute sequentially; that is, looking through your code, the system progresses from statement to statement without anything "strange" (variables being changed, threads being started, etc.) between them. HOWEVER, "strange" things do happen, and in fact they happen quite regularly in scripts. We say that the script system has "concurrency" when things can happen between statements.

===Why Concurrency?===
So why go to all this trouble with concurrency? The script system has concurrency because we never know when things are going to happen. The player could give a command to the unit, the unit could run into a wall, rocks could fall out of the sky and kill the unit, and so forth. Without concurrency we would have to check very often whether which of all possible events had happened recently in order to determine what to do next. This would suck.

==Dealing With Concurrency==
Every time a callin is called or a start-script statement is executed, a "thread" is created. At any one time, only one thread is being executed at a time, but sometimes a thread will stop executing for a while and continue later, while several other threads will execute in the meantime. Most of the time your script is guaranteed to execute sequentially. If you say x = 1;, it will stay 1 unless you change it again. The exceptions are as follows:

* Before a script starts.
* After a wait-for-move or wait-for-turn statement.
* After a sleep statement.

During these times, any other thread has the ability to come in and change all your static variables, tell your pieces to move, turn, and spin, and so forth. Therefore, you cannot always assume these things will be the way you left them when execution of the thread resumes. If it is possible that another thread will change something that you need to know about, you need to check it after any of these times.

==Sleeping==

You can have a thread sleep by using a sleep statement:

sleep [time in ms];

This is useful for delaying events and in making loops execute every so often. If you want to wait until a piece moves into position, use wait-for-move or wait-for-turn instead.

==Signals==

Signals provide a way to kill threads in their sleep. Signals are bitmasks. There are two statement types dealing with signals: signal and set-signal-mask.

signal [bitmask];

kills all sleeping threads that overlap the bitmask.

set-signal-mask [bitmask];

sets what signals kill the current thread.

This has several applications. For functions that are called regularly, such as AimWeaponX(), this prevents multiple copies of the same thread from running at the same time. It is also a way (but not the only or necessarily best way) to interrupt another thread.

==call-script==

Use as follows:

call-script [function]([args]);

This does not start a new thread! The calling function will not continue until the called function returns.

==start-script==

At first glance, this is similar to call-script:

start-script [function]([args]);

However, start-script ''does'' create a new thread, and the calling function ''doesn't'' wait until the started function returns before continuing. By default, the new thread shares the same signal mask as its parent, although you can set it manually if you like. Apart from this, the two threads execute completely independently.

Animation-CobThreads

2008-05-27T22:19:02Z

Evil4Zerggin:

==Source==

https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobThread.cpp

==Introduction==

Much of the time you can expect your script to execute sequentially; that is, looking through your code, the system progresses from statement to statement without anything "strange" (variables being changed, threads being started, etc.) between them. HOWEVER, "strange" things do happen, and in fact they happen quite regularly in scripts. We say that the script system has "concurrency".

===Why Concurrency?===
So why go to all this trouble with concurrency? The script system has concurrency because we never know when things are going to happen. The player could give a command to the unit, the unit could run into a wall, rocks could fall out of the sky and kill the unit, and so forth. Without concurrency we would have to check very often whether which of all possible events had happened recently in order to determine what to do next. This would suck.

==Dealing With Concurrency==
Every time a callin is called or a start-script statement is executed, a "thread" is created. At any one time, only one thread is being executed at a time, but sometimes a thread will stop executing for a while and continue later, while several other threads will execute in the meantime. Most of the time your script is guaranteed to execute sequentially. If you say x = 1;, it will stay 1 unless you change it again. The exceptions are as follows:

* Before a script starts.
* After a wait-for-move or wait-for-turn statement.
* After a sleep statement.

During these times, any other thread has the ability to come in and change all your static variables, tell your pieces to move, turn, and spin, and so forth. Therefore, you cannot always assume these things will be the way you left them when execution of the thread resumes. If it is possible that another thread will change something that you need to know about, you need to check it after any of these times.

==Sleeping==

You can have a thread sleep by using a sleep statement:

sleep [time in ms];

This is useful for delaying events and in making loops execute every so often. If you want to wait until a piece moves into position, use wait-for-move or wait-for-turn instead.

==Signals==

Signals provide a way to kill threads in their sleep. Signals are bitmasks. There are two statement types dealing with signals: signal and set-signal-mask.

signal [bitmask];

kills all sleeping threads that overlap the bitmask.

set-signal-mask [bitmask];

sets what signals kill the current thread.

This has several applications. For functions that are called regularly, such as AimWeaponX(), this prevents multiple copies of the same thread from running at the same time. It is also a way (but not the only or necessarily best way) to interrupt another thread.

==call-script==

Use as follows:

call-script [function]([args]);

This does not start a new thread! The calling function will not continue until the called function returns.

==start-script==

At first glance, this is similar to call-script:

start-script [function]([args]);

However, start-script ''does'' create a new thread, and the calling function ''doesn't'' wait until the started function returns before continuing. By default, the new thread shares the same signal mask as its parent, although you can set it manually if you like. Apart from this, the two threads execute completely independently.

Animation-CobThreads

2008-05-27T22:05:09Z

Evil4Zerggin: New page: ==Source== https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobThread.cpp ==Introduction== Much of the time you can expect your script to execute sequentially; that is, loo...

Game and Unit development

2008-05-27T21:30:42Z

Evil4Zerggin: /* Scripting and Animation - COB/BOS Files */

filehosting at 20080405:

http://www.tasdownloads.com/faq.php

http://spring.jobjol.nl/subcategory.php?id=1&language=English

http://spring-portal.com/

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*http://taspring.clan-sy.com/wiki/Create_units - old Wiki 
*[[Mod Development]]
*[[Mod specification]] 
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]

==Unit Development==
====Models - s3o Files====
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====Scripting and Animation - COB/BOS Files====
*[[COB_Callins]]
*[[COB_Constants]]
*[[COB_Threads]]
*[[Image:Usa_flag.gif]][[Image:France_flag.gif]][[Units:.bos/.COB]] -all tags for make a animation file
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[http://www.tadesigners.com/bos1.htm TADesigners] have a nice tutorial too
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Image:France_flag.gif]] [[exemples de fichiers .fbi]]
*[[image:usa_flag.gif]][[ all tags & details with a exemple ]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomExplosionGenerators|Mod Development:Custom explosions]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

Animation-CobConstants

2008-05-27T21:27:48Z

Evil4Zerggin: New page: ==Source== This has a list of all COB SET/GET keys: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobInstance.cpp You'll want to include a file with these constants in yo...

Animation-CobCallins

2008-05-27T21:19:01Z

Evil4Zerggin:

==Source==

Callins are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Callins==

===General===

'''Create()'''
Called when the unit is created (''not'' finished'').

'''Activate()/Deactivate()'''

Called when the unit is turned on/off.

'''Killed(severity, corpsetype)'''

Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

'''StartMoving()/StopMoving()'''

Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.

'''SetSFXOccupy(terraintype)'''

Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.

'''MoveRate[0...3]()'''

Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.

'''SetDirection(direction)'''

Used only for wind generators. Gives the direction of the wind.

'''SetSpeed(speed)'''

Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

'''AimWeaponX(heading, pitch)'''

Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).

'''AimFromWeaponX(piecenum)'''

You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.

'''QueryWeaponX(piecenum)'''

You should set piecenum to a piece of the model. The shot starts from this piece of the model. LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips

'''FireWeaponX()'''

Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).

'''ShotX()'''

Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.

'''EndBurstX()'''

Called after the last shot in a burst.

'''BlockShotX()'''

'''TargetWeightX()'''

'''RockUnit(anglex, anglez)'''

Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.

'''HitByWeaponID(damage, weaponid?, unitid?)'''

Game and Unit development

2008-05-27T21:15:39Z

Evil4Zerggin:

filehosting at 20080405:

http://www.tasdownloads.com/faq.php

http://spring.jobjol.nl/subcategory.php?id=1&language=English

http://spring-portal.com/

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*http://taspring.clan-sy.com/wiki/Create_units - old Wiki 
*[[Mod Development]]
*[[Mod specification]] 
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]

==Unit Development==
====Models - s3o Files====
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====Scripting and Animation - COB/BOS Files====
*[[COB_Callins]]
*[[COB_Constants]]
*[[Image:Usa_flag.gif]][[Image:France_flag.gif]][[Units:.bos/.COB]] -all tags for make a animation file
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[http://www.tadesigners.com/bos1.htm TADesigners] have a nice tutorial too
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Image:France_flag.gif]] [[exemples de fichiers .fbi]]
*[[image:usa_flag.gif]][[ all tags & details with a exemple ]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomExplosionGenerators|Mod Development:Custom explosions]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

Animation-CobCallins

2008-05-27T21:08:54Z

Evil4Zerggin:

==Source==

Callins are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Callins==

===General===

====Create()====
Called when the unit is created (''not'' finished'').

====Activate()/Deactivate()====
Called when the unit is turned on/off.

====Killed(severity, corpsetype)====
Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

====StartMoving()/StopMoving()====
Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.

====SetSFXOccupy(terraintype)====
Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.

====MoveRate[0...3]()====
Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.

====SetDirection(direction)====
Used only for wind generators. Gives the direction of the wind.

====SetSpeed(speed)====
Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

====AimWeaponX(heading, pitch)====
Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).

====AimFromWeaponX(piecenum)====
You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.

====QueryWeaponX(piecenum)====
You should set piecenum to a piece of the model. The shot starts from this piece of the model. LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips

====FireWeaponX()====
Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).

====ShotX()====
Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.

====EndBurstX()====
Called after the last shot in a burst.

====BlockShotX()====

====TargetWeightX()====

====RockUnit(anglex, anglez)====
Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.

====HitByWeaponID(damage, weaponid?, unitid?)====

Animation-CobCallins

2008-05-27T21:08:35Z

Evil4Zerggin:

==Source==

Callins are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Callins==

===General===

====Create()====
Called when the unit is created (''not'' finished'').

====Activate()/Deactivate()====
Called when the unit is turned on/off.

====Killed(severity, corpsetype)====
Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

====StartMoving()/StopMoving()====
Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.

====SetSFXOccupy(terraintype)====
Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.

====MoveRate[0...3]()====
Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.

====SetDirection(direction)====
Used only for wind generators. Gives the direction of the wind.

====SetSpeed(speed)====
Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

====AimWeaponX(heading, pitch)====
Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).

====AimFromWeaponX(piecenum)====
You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.

====QueryWeaponX(piecenum)====
You should set piecenum to a piece of the model. The shot starts from this piece of the model. LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips

====FireWeaponX()====
Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).

====ShotX()====
Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.

====EndBurstX()====
Called after the last shot in a burst.

====BlockShotX()====

===TargetWeightX()====

====RockUnit(anglex, anglez)====
Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.

====HitByWeaponID(damage, weaponid?, unitid?)====

Animation-CobCallins

2008-05-27T20:37:18Z

Evil4Zerggin:

==Source==

Callins are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Callins==

===General===

====Create()====
Called when the unit is created (''not'' finished'').

====Activate()/Deactivate()====
Called when the unit is turned on/off.

====Killed(severity, corpsetype)====
Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

====StartMoving()/StopMoving()====
Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.

====SetSFXOccupy(terraintype)====
Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.

====SetDirection(direction)====
Used only for wind generators. Gives the direction of the wind.

====SetSpeed(speed)====
Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

====AimWeaponX(heading, pitch)====
Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).

====AimFromWeaponX(piecenum)====
You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.

====QueryWeaponX(piecenum)====
You should set piecenum to a piece of the model. The shot starts from this piece of the model. LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips

====FireWeaponX()====
Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).

====ShotX()====
Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.

Animation-CobCallins

2008-05-27T20:26:26Z

Evil4Zerggin:

Animation-CobCallins

2008-05-27T20:11:23Z

Evil4Zerggin:

Animation-CobCallins

2008-05-27T20:07:22Z

Evil4Zerggin: New page: ==Source== Callins are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Source==

Callins are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

Game and Unit development

2008-05-27T20:01:18Z

Evil4Zerggin: /* Scripting and Animation - COB/BOS Files */

filehosting at 20080405:

http://www.tasdownloads.com/faq.php

http://spring.jobjol.nl/subcategory.php?id=1&language=English

http://spring-portal.com/

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*http://taspring.clan-sy.com/wiki/Create_units - old Wiki 
*[[Mod Development]]
*[[Mod specification]] 
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]

==Unit Development==
====Models - s3o Files====
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====Scripting and Animation - COB/BOS Files====
*[[COB_Callins]]
*[[Image:Usa_flag.gif]][[Image:France_flag.gif]][[Units:.bos/.COB]] -all tags for make a animation file
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[http://www.tadesigners.com/bos1.htm TADesigners] have a nice tutorial too
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Image:France_flag.gif]] [[exemples de fichiers .fbi]]
*[[image:usa_flag.gif]][[ all tags & details with a exemple ]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomExplosionGenerators|Mod Development:Custom explosions]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

CSpherePartSpawner

2008-03-25T04:01:02Z

Evil4Zerggin:

== Introduction ==

Makes a simple, one-color expanding sphere.

== Source ==

https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Projectiles/Unsynced/SpherePartProjectile.cpp

== Suggested Use ==

This is good for concussion effects.

== Parameters ==

These are pretty intuitive. Unfortunately there is no way to set the starting radius at time of writing.

=== alpha ===

=== ttl ===

=== expansionSpeed ===

=== color ===

Heatcloud

2008-03-25T03:59:01Z

Evil4Zerggin:

==Introduction==

heatcloud is one of the simplest and most common explosion types. Ironically, it is also one of the least intuitive. First of all, ignore the name--it basically makes an expanding image at the point at which it is spawned.

==Source==

https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Projectiles/Unsynced/HeatCloudProjectile.cpp

==Suggested Use==

heatcloud makes a good main piece of an explosion. Think of it as a background for the other components of your explosion generator.

==Parameters==

=== heat, maxheat, heatFalloff ===

Most explosions have alpha and ttl. I don't know why heatcloud uses these instead. Basically:

Starting alpha = heat / maxheat

ttl = heat / heatFalloff

The alpha decreases linearly across the heatcloud's lifetime.

=== size, sizeGrowth ===

The heatcloud starts at size size and grows sizeGrowth each frame.

=== sizemod, sizemodmod ===

It seems that the heatcloud expands by a factor of (1 - sizemod) each frame. The sizemod itself is multiplied by sizemodmod every frame. Most of the time it's probably best just not to contemplate these.

=== texture ===

The texture of the heatcloud.