https://springrts-wiki.p2004a.com/mediawiki/api.php?action=feedcontributions&feedformat=atom&user=AnarchidSpring - User contributions [en]2026-11-08T19:53:50ZUser contributionsMediaWiki 1.43.11https://springrts-wiki.p2004a.com/mediawiki/index.php?title=Assimp&diff=2186Assimp2020-05-06T10:32:26Z<p>Anarchid: /* Blender Workflow Tutorial */</p>
<hr />
<div>[[Engine_Development|Development]] < [[Game_and_Unit_development|Game Development]] < {{FULLPAGENAME}}<br />
<br />
=Assimp=<br />
Open Asset Import Library (short name: Assimp) is used in Spring for loading a number of common and well supported model formats (.3ds, .dae, .lwo, .blend - currently .obj is parsed by a different code path).<br />
<br />
What Spring supports in its Assimp renderer:<br />
* extended metafile (<code>%modelfilename%.lua</code> next to the modefile)<br />
* still uses tex1 & tex2 texture system of S3O (same shader as S3O)<br />
* 2nd texcoord<br />
* loading of the texture filepaths from the model (don't have to be in <code>unittextures/</code>)<br />
* when texture filepaths aren't included in the model, it searches for <code>%modelfilename%.*</code> & <code>%modelfilename%2.*</code> in <code>unittextures/</code><br />
* special modelpieces `SpringHeight` & `SpringRadius` {{removed|101.0}}<br />
* {{new|102.0}} auto-normalize normals and tangents for all AssImp-loaded models<br />
* {{new|95.0}} allow modellers to work around {{mantis|3552}} (differing axes conventions between software) by recognizing a number of new piece-table keys as follows<br />
<br />
For the root piece: {{removed|104.0}}<br />
* "xaxis" = float3, "yaxis" = float3, "zaxis" = float3 (determine global orientation of model)<br />
For all pieces: {{removed|104.0}}<br />
* "rotAxisSigns" = float3 (determines direction of script-applied rotations around each axis)<br />
* "rotAxisMap" = number (currently can only be 0=XYZ or 3=XZY, determines coordinate conversion)<br />
<br />
=Assimp Textures=<br />
See [[3DModels:Textures#Textures_-_Assimp_Model_Formats_.28DAE.2CMDL.2CMD3_and_others_except_OBJ.29 |3DModels:Textures (Assimp Section)]]<br />
<br />
=Standard Workflow=<br />
The following Workflow is provided for a standard 3D Modeling package using the Z = forward, Y = upwards convention, like Maya, Modo or Lightwave. You can also use Blender to export models for ASSIMP, as covered in the next section.<br />
<br />
* [[3DModels:AssimpWorkflow]]<br />
* [[3DModels:AssimpMetadata]]<br />
<br />
=Blender Workflow Tutorial=<br />
This is a stub containing a simple outline of a Blender workflow.<br />
<br />
# Open an existing Blender model or import a different format through the File menu (File > Import). You can import s3o models - complete with materials - using the [https://github.com/sanguinariojoe/blender_s3o_import s3o import] plugin.<br />
# Compose your model by making a series of rigid pieces, and parenting them to one another (ctrl+P). These will be imported as `pieces` into Spring.<br />
# It is preferred to apply all scale transforms, because uneven transforms will not be tolerated by Spring. You can keep rotations, though.<br />
# Blender is Z-up and Spring is Y-up. Spring will import Blender models as Z-up. If you want to fix that, add a root piece to your model, and rotate its children 90 degrees, such that their local Y-axis points up.<br />
# Make sure you have a lamp in your scene while in this mode or your model will be dark. You can delete it before export.<br />
# If you want to animate the model using the animation exporter [https://github.com/Anarchid/blender2lus addon] later, set the rotation mode for all your pieces to be Euler ZXY.<br />
# Applying texture: <br />
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.<br />
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode. You can select multiple objects if you want to unwrap the entire model without going piece-by-piece.<br />
## Hit A to select all your faces.<br />
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.<br />
## If you don't see any faces you'll need to add the UVMap to a new texture:<br />
### In the Properties view click on Textures (checkerboard icon).<br />
### Click on Add New Texture (plus icon).<br />
### Select Type = Image or Movie.<br />
### Under Image, click on the image icon and choose your image file.<br />
### Under Mapping, select Coordinates = UV.<br />
### Under Influence > Diffuse, check Color and make sure it's 1.00.<br />
## To add a normalmap:<br />
### Repeat steps 5.5.1 to 5.5.5.<br />
### Under Image Sampling, check Normal Map.<br />
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.<br />
## You'll need to do this for each piece.<br />
# Piece hierarchy:<br />
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.<br />
# Setting piece origins:<br />
## Select a piece.<br />
## Place the 3D cursor where you want the origin to be (left-click).<br />
## Click on Object > Transform > Origin to 3D Cursor.<br />
## You can now rotate your pieces:<br />
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.<br />
### Rotate.<br />
## Do this for all your pieces.<br />
# Preparing for Spring (this may or may not apply depending on how assimp handles your model.):<br />
## Ensure that the scales for each object in your scene are uniform (that is, x, y, and z scales are equal to each other). A quick way to ensure that is select all (a) and apply scale (ctrl+a -> scale).<br />
# Save your model.<br />
# Select all the pieces of your model, ignore the lamp.<br />
# Click on File > Export > Collada.<br />
# Check "Export Only Selected" and export.<br />
# The dae file will be used as your object.<br />
<br />
Don't hesitate to google for answers if you bump into questions with how to use Blender itself. It's a powerful piece of software with a lot of tutorials on how to use - the scope of this article is not teaching how to use Blender, but only how to use Blender for making Spring models.<br />
<br />
<br />
<br />
<br />
[[Category:3D Models]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Assimp&diff=2185Assimp2020-05-06T10:21:18Z<p>Anarchid: /* Blender Workflow Tutorial */</p>
<hr />
<div>[[Engine_Development|Development]] < [[Game_and_Unit_development|Game Development]] < {{FULLPAGENAME}}<br />
<br />
=Assimp=<br />
Open Asset Import Library (short name: Assimp) is used in Spring for loading a number of common and well supported model formats (.3ds, .dae, .lwo, .blend - currently .obj is parsed by a different code path).<br />
<br />
What Spring supports in its Assimp renderer:<br />
* extended metafile (<code>%modelfilename%.lua</code> next to the modefile)<br />
* still uses tex1 & tex2 texture system of S3O (same shader as S3O)<br />
* 2nd texcoord<br />
* loading of the texture filepaths from the model (don't have to be in <code>unittextures/</code>)<br />
* when texture filepaths aren't included in the model, it searches for <code>%modelfilename%.*</code> & <code>%modelfilename%2.*</code> in <code>unittextures/</code><br />
* special modelpieces `SpringHeight` & `SpringRadius` {{removed|101.0}}<br />
* {{new|102.0}} auto-normalize normals and tangents for all AssImp-loaded models<br />
* {{new|95.0}} allow modellers to work around {{mantis|3552}} (differing axes conventions between software) by recognizing a number of new piece-table keys as follows<br />
<br />
For the root piece: {{removed|104.0}}<br />
* "xaxis" = float3, "yaxis" = float3, "zaxis" = float3 (determine global orientation of model)<br />
For all pieces: {{removed|104.0}}<br />
* "rotAxisSigns" = float3 (determines direction of script-applied rotations around each axis)<br />
* "rotAxisMap" = number (currently can only be 0=XYZ or 3=XZY, determines coordinate conversion)<br />
<br />
=Assimp Textures=<br />
See [[3DModels:Textures#Textures_-_Assimp_Model_Formats_.28DAE.2CMDL.2CMD3_and_others_except_OBJ.29 |3DModels:Textures (Assimp Section)]]<br />
<br />
=Standard Workflow=<br />
The following Workflow is provided for a standard 3D Modeling package using the Z = forward, Y = upwards convention, like Maya, Modo or Lightwave. You can also use Blender to export models for ASSIMP, as covered in the next section.<br />
<br />
* [[3DModels:AssimpWorkflow]]<br />
* [[3DModels:AssimpMetadata]]<br />
<br />
=Blender Workflow Tutorial=<br />
This is a stub containing a simple outline of a Blender workflow.<br />
<br />
# Open an existing Blender model or import a different format through the File menu (File > Import). You can import s3o models - complete with materials - using the [https://github.com/sanguinariojoe/blender_s3o_import s3o import] plugin.<br />
# Compose your model by making a series of rigid pieces, and parenting them to one another (ctrl+P). These will be imported as `pieces` into Spring.<br />
# It is preferred to apply all scale transforms, because uneven transforms will not be tolerated by Spring. You can keep rotations, though.<br />
# Blender is Z-up and Spring is Y-up. Spring will import Blender models as Z-up. If you want to fix that, add a root piece to your model, and rotate its children 90 degrees, such that their local Y-axis points up.<br />
# Make sure you have a lamp in your scene while in this mode or your model will be dark. You can delete it before export.<br />
# If you want to animate the model using the animation exporter addon later, set the rotation mode for all your pieces to be Euler ZXY.<br />
# Applying texture: <br />
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.<br />
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode. You can select multiple objects if you want to unwrap the entire model without going piece-by-piece.<br />
## Hit A to select all your faces.<br />
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.<br />
## If you don't see any faces you'll need to add the UVMap to a new texture:<br />
### In the Properties view click on Textures (checkerboard icon).<br />
### Click on Add New Texture (plus icon).<br />
### Select Type = Image or Movie.<br />
### Under Image, click on the image icon and choose your image file.<br />
### Under Mapping, select Coordinates = UV.<br />
### Under Influence > Diffuse, check Color and make sure it's 1.00.<br />
## To add a normalmap:<br />
### Repeat steps 5.5.1 to 5.5.5.<br />
### Under Image Sampling, check Normal Map.<br />
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.<br />
## You'll need to do this for each piece.<br />
# Piece hierarchy:<br />
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.<br />
# Setting piece origins:<br />
## Select a piece.<br />
## Place the 3D cursor where you want the origin to be (left-click).<br />
## Click on Object > Transform > Origin to 3D Cursor.<br />
## You can now rotate your pieces:<br />
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.<br />
### Rotate.<br />
## Do this for all your pieces.<br />
# Preparing for Spring (this may or may not apply depending on how assimp handles your model.):<br />
## Ensure that the scales for each object in your scene are uniform (that is, x, y, and z scales are equal to each other). A quick way to ensure that is select all (a) and apply scale (ctrl+a -> scale).<br />
# Save your model.<br />
# Select all the pieces of your model, ignore the lamp.<br />
# Click on File > Export > Collada.<br />
# Check "Export Only Selected" and export.<br />
# The dae file will be used as your object.<br />
<br />
Don't hesitate to google for answers if you bump into questions with how to use Blender itself. It's a powerful piece of software with a lot of tutorials on how to use - the scope of this article is not teaching how to use Blender, but only how to use Blender for making Spring models.<br />
<br />
<br />
<br />
<br />
[[Category:3D Models]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Lua:Callins&diff=10788Lua:Callins2016-11-19T17:20:52Z<p>Anarchid: add projID doc to Explosion</p>
<hr />
<div>= Lua Callins =<br />
This page is future looking to unified widget/gadget (aka "addon") handler, which may yet be some way off, c.f. the [https://github.com/spring/spring/blob/ebb704e008f6ea645947d07be1cfcc272af0428f/doc/changelog.txt#L71 changelog].<br />
<br />
Related Sourcecode :<br />
[https://github.com/spring/spring/blob/d9b3927a528a876b9ab4042771e82b050267572a/rts/Lua/LuaHandle.cpp https://github.com/spring/spring/rts/Lua/LuaHandle.cpp]<br />
<br />
For now, to use these addons in a widget, replace addon with widget and, for a gadget, replace addon with gadget. For example,<br />
<code><pre><br />
function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)<br />
... <br />
end<br />
</pre></code><br />
<br />
Some functions may differ between (synced) gadget and widgets; those are in the [[#Synced_-_Unsynced_Shared]] section. Essentially the reason is that all information should be available to synced (game logic controlling) gadgets, but restricted to unsynced gadget/widget (e.g. information about an enemy unit only detected via radar and not yet in LOS). In such cases the full (synced) param list is documented.<br />
<br />
== Common ==<br />
{{LuaCallin<br />
|name = Initialize<br />
|info = Called when the addon is (re)loaded.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = Shutdown<br />
|info = Called when the addon or the game is shutdown.<br />
}}<br />
<br />
<br />
== Unsynced Only ==<br />
<br />
{{LuaCallin<br />
|name = DefaultCommand<br />
|args = type, id<br />
|return = {{type|number}} cmdID<br />
|info = Used to set the default command when a unit is selected. First parameter is the type of the object pointed at (either "unit or "feature") and the second is its {{var|unitID}} or {{var|featureID}} respectively. <br />
}}<br />
<br />
{{LuaCallin<br />
|name = CommandNotify<br />
|args = cmdID, cmdParams, cmdOptions<br />
|return = {{type|bool}} removeCmd<br />
|info = Called when a command is issued. Returning {{value|true}} deletes the command and does not send it through the network.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = CommandsChanged<br />
|args = None<br />
|return = ?<br />
|info = Called when the command descriptions changed, e.g. when selecting or deselecting a unit.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = WorldTooltip<br />
|args = ttType, data1, data2, data3<br />
|return = {{type|string}} newTooltip<br />
|info = The parameters can be {{value|"unit"}}, {{var|unitID}}; {{value|"feature"}}, {{var|featureID}}; {{value|"ground"}}, {{var|posX}}, {{var|posY}}, {{var|posZ}} or {{value|"selection"}}.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnsyncedHeightMapUpdate<br />
|args = ???<br />
|info = Called when the unsynced copy of the height-map is altered.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = GameProgress<br />
|args = serverFrameNum<br />
|info = Called every 60 frames, calculating delta between GameFrame and GameProgress. Can give an ETA about catching up with simulation for mid-game join players.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = GameSetup<br />
|args = state, ready, playerStates<br />
|return = {{type|bool}} success, {{type|bool}} newReady<br />
|info = ???<br />
}}<br />
<br />
{{LuaCallin<br />
|name = SunChanged<br />
|args = ???<br />
|info = ???<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AddConsoleLine<br />
|args = msg, priority<br />
|info = Called when text is entered into the console (e.g. Spring.Echo).<br />
}}<br />
<br />
{{LuaCallin<br />
|name = RecvSkirmishAIMessage<br />
|args = aiTeam, dataStr<br />
|return = ???<br />
|info = ???<br />
}}<br />
<br />
{{LuaCallin<br />
|name = RecvFromSynced<br />
|args = ...<br />
|info = Receives data sent via [[Lua_System#Synced|SendToUnsynced]] callout.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = Save<br />
|args = zip<br />
|info = Called when a chat command '/save' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file. See [[Lua_SaveLoad#Save_.28_zip_.29_-.3E_nil|Lua_SaveLoad]].<br />
}}<br />
<br />
{{LuaCallin<br />
|name = LoadProgress<br />
|args = message, replaceLastLine<br />
|info = Only available to LuaIntro.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = GroupChanged<br />
|args = groupID<br />
|info = Called when a unit is added to or removed from a control group. Currently implemented for widgets only.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = ConfigureLayout<br />
|args = ???<br />
|return = ???<br />
|info = ???<br />
}}<br />
<br />
=== Input ===<br />
{{LuaCallin<br />
|name = IsAbove<br />
|args = x, y<br />
|return = {{type|bool}} isAbove<br />
|info = Called every Update. Must return {{value|true}} for {{name|Mouse*}} events and {{name|GetToolTip}} to be called.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = GetTooltip<br />
|args = x, y<br />
|return = {{type|string}} tooltip<br />
|info = Called when {{name|IsAbove}} returns {{value|true}}.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = KeyPress<br />
|args = key, mods, isRepeat<br />
|return = {{type|bool}} becomeOwner<br />
|info = Called repeatedly when a key is pressed down. If you want an action to occur only once check for {{var|1=isRepeat == {{value|false}}}}. The {{var|mods}} parameter is a {{type|table}}, with keys {{value|"alt"}}, {{value|"ctrl"}}, {{value|"meta"}} and {{value|"shift"}} each having a boolean value. Return {{value|true}} if you don't want other callins or the engine to also receive this keypress.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = KeyRelease<br />
|args = key<br />
|return = {{type|bool}}<br />
|info = Called when the key is released.<br />
}}<br />
<br />
<br />
{{LuaCallin<br />
|name = TextInput<br />
|args = utf8char<br />
|info = Called whenever a key press results in text input. Introduced in 97.0.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = JoystickEvent<br />
|args = ???<br />
|info = ???<br />
}}<br />
<br />
{{LuaCallin<br />
|name = MousePress<br />
|args = x, y, button<br />
|return = {{type|bool}} becomeMouseOwner<br />
|info = Called when a mouse button is pressed. The {{var|button}} parameter supports up to 7 buttons. Must return {{value|true}} for {{name|MouseRelease}} and other functions to be called.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = MouseRelease<br />
|args = x, y, button<br />
|return = bool becomeMouseOwner<br />
|info = Called when a mouse button is released. Please note that in order to have Spring call {{name|MouseRelease}}, you need to have a {{name|MousePress}} call-in in the same addon that returns {{value|true}}.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = MouseWheel<br />
|args = up, value<br />
|info = Called when the mouse wheel is moved. The parameters indicate the direction and amount of travel.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = MouseMove<br />
|args = x, y, dx, dy, button<br />
|info = Called when the mouse is moved. The {{var|dx}} and {{var|dy}} parameters indicate the distance travelled, whereas the first two indicate the final position.<br />
}}<br />
<br />
=== Players ===<br />
{{LuaCallin<br />
|name = PlayerChanged<br />
|args = playerID<br />
|info = Called whenever a player's status changes e.g. becoming a spectator.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = PlayerAdded<br />
|args = playerID<br />
|info = Called whenever a new player joins the game.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = PlayerRemoved<br />
|args = playerID, reason<br />
|info = Called whenever a player is removed from the game.<br />
}}<br />
<br />
=== Downloads ===<br />
<br />
{{LuaCallin<br />
|name = DownloadStarted<br />
|args = id<br />
|info = Called when a [[Pr-downloader]] download is started via [[Lua_VFS#Archives|VFS.DownloadArchive]].<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DownloadFinished<br />
|args = id<br />
|info = Called when a [[Pr-downloader]] download finishes successfully.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DownloadFailed<br />
|args = id, errorID<br />
|info = Called when a [[Pr-downloader]] download fails to complete.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DownloadProgress<br />
|args = id, downloaded, total<br />
|info = Called incrementally during a [[Pr-downloader]] download.<br />
}}<br />
<br />
=== Drawing ===<br />
{{LuaCallin<br />
|name = ViewResize<br />
|args = viewSizeX, viewSizeY<br />
|info = Called whenever the window is resized.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = Update<br />
|args = dt<br />
|info = Called for every draw frame. The parameter is the time since the last update. Perform calculations in here and only drawing in Draw* callins.}}<br />
<br />
Inside the Draw* functions, you can use the [[Lua_OpenGL_Api | Lua OpenGL Api]] to draw graphics.<br />
<br />
{{LuaCallin<br />
|name = DrawGenesis<br />
|info = Doesn't render to screen! Use this callin to update textures, shaders, etc.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawWorldPreUnit<br />
|info = Spring draws units, features, some water types, cloaked units, and the sun.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawWorld<br />
|info = Spring draws command queues, 'map stuff', and map marks.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawWorldShadow<br />
|info = ???<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawWorldReflection<br />
|info = ???<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawWorldRefraction<br />
|info = ???<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawGroundPreForward<br />
|info = Runs at the start of the forward pass when a custom map shader has been assigned via [[Lua_UnsyncedCtrl#Map|{{name|Spring.SetMapShader}}]] (convenient for setting uniforms).<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawGroundPreDeferred<br />
|info = Runs at the start of the deferred pass when a custom map shader has been assigned via [[Lua_UnsyncedCtrl#Map|{{name|Spring.SetMapShader}}]] (convenient for setting uniforms).<br />
}}<br />
<br />
<br />
{{LuaCallin<br />
|name = DrawGroundPostDeferred<br />
|info = This runs at the end of its respective deferred pass and allows proper frame compositing (with ground flashes/decals/foliage/etc, which are drawn between it and [[#API:DrawWorldPreUnit|{{name|DrawWorldPreUnit}}]]) via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]].<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawUnitsPostDeferred<br />
|info = Runs at the end of the unit deferred pass to inform Lua code it should make use of the {{value|$model_gbuffer_*}} textures before another pass overwrites them (and to allow proper blending with e.g. cloaked objects which are drawn between these events and [[#API:DrawWorld|{{name|DrawWorld}}]] via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]]). N.B. The *PostDeferred events are only sent (and only have a real purpose) if forward drawing is disabled.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawFeaturesPostDeferred<br />
|info = Runs at the end of the feature deferred pass to inform Lua code it should make use of the {{value|$model_gbuffer_*}} textures before another pass overwrites them (and to allow proper blending with e.g. cloaked objects which are drawn between these events and [[#API:DrawWorld|{{name|DrawWorld}}]] via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]]). N.B. The *PostDeferred events are only sent (and only have a real purpose) if forward drawing is disabled.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawScreen<br />
|info = ???<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawScreenEffects<br />
|args = vsx, vsy<br />
|info = Where {{var|vsx}}, {{var|vsy}} are screen coordinates.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawLoadScreen<br />
|info = {{new|95.0}} Only available to LuaIntro, draws custom load screens.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawInMinimap<br />
|args = sx, sy<br />
|info = Where {{var|sx}}, {{var|sy}} are values relative to the minimap's position and scale.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawInMinimapBackground<br />
|args = sx, sy<br />
|info = Where {{var|sx}}, {{var|sy}} are values relative to the minimap's position and scale.<br />
}}<br />
<br />
=== Custom Object Rendering ===<br />
For the following calls {{var|drawMode}} can be one of the following, {{var|1=notDrawing = {{value|0}}}}, {{var|1=normalDraw = {{value|1}}}}, {{var|1=shadowDraw = {{value|2}}}}, {{var|1=reflectionDraw = {{value|3}}}}, {{var|1=refractionDraw = {{value|4}}}}, and finally {{var|1=gameDeferredDraw = {{value|5}}}} which was added in 102.0.<br />
<br />
{{LuaCallin<br />
|name = DrawUnit<br />
|args = unitID, drawMode<br />
|return = {{type|bool}} suppressEngineDraw<br />
|info = For custom rendering of units, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin|enabled here]]. <br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawFeature<br />
|args = unitID, drawMode<br />
|return = {{type|bool}} suppressEngineDraw<br />
|info = For custom rendering of features, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin|enabled here]]. <br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawShield<br />
|args = unitID, weaponID, drawMode<br />
|return = {{type|bool}} suppressEngineDraw<br />
|info = For custom rendering of [[Gamedev:WeaponDefs#Shield_(WeaponType)|shields]].<br />
}}<br />
<br />
{{LuaCallin<br />
|name = DrawProjectile<br />
|args = projectileID, drawMode<br />
|return = {{type|bool}} suppressEngineDraw<br />
|info = For custom rendering of weapon (& other) projectiles.<br />
}}<br />
<br />
== Synced - Unsynced Shared ==<br />
<br />
{{LuaCallin<br />
|name = GotChatMsg<br />
|args = msg, player<br />
|info = Called when a player issues a UI command e.g. types {{var|/foo}} or {{var|/luarules foo}}.<br />
}}<br />
<br />
=== Game ===<br />
<br />
{{LuaCallin<br />
|name = GameID<br />
|args = gameID<br />
|info = Called once to deliver the {{var|gameID}}. As of 101.0+ the string is encoded in hex.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = GamePaused<br />
|info = Called when the game is paused.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = GameOver<br />
|args = winningAllyTeams<br />
|info = The parameter is a {{type|table}} list of winning allyTeams, if empty the game result was undecided (like when dropping from an host).<br />
}}<br />
<br />
{{LuaCallin<br />
|name = GameFrame<br />
|args = frame<br />
|info = Called for every game simulation frame (30 per second). Starts at frame {{value|0}} in 101.0+ and {{value|1}} in previous versions.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = GamePreload<br />
|info = Called before the 0 gameframe.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = GameStart<br />
|info = Called upon the start of the game.<br />
}}<br />
<br />
=== Teams ===<br />
{{LuaCallin<br />
|name = TeamChanged<br />
|args = teamID<br />
|info = ???<br />
}}<br />
<br />
{{LuaCallin<br />
|name = TeamDied<br />
|args = teamID<br />
|info = Called when a team dies (see [[Lua_SyncedCtrl#Game_End|Spring.KillTeam]]).<br />
}}<br />
<br />
=== Units ===<br />
{{LuaCallin<br />
|name = UnitCreated<br />
|args = unitID, unitDefID, unitTeam, builderID<br />
|info = Called at the moment the unit is created.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitFinished<br />
|args = unitID, unitDefID, unitTeam<br />
|info = Called at the moment the unit is completed.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitFromFactory<br />
|args = unitID, unitDefID, unitTeam, factID, factDefID, userOrders<br />
|info = Called when a factory finishes construction of a unit.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitReverseBuilt<br />
|args = unitID, unitDefID, unitTeam<br />
|info = Called when a living unit becomes a nanoframe again.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitGiven<br />
|args = unitID, unitDefID, newTeam, oldTeam<br />
|info = Called when a unit is transferred between teams.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitTaken<br />
|args = unitID, unitDefID, oldTeam, newTeam<br />
|info = Called when a unit is transferred between teams.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitDamaged<br />
|args = unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam<br />
|info = Called when a unit is damaged (after {{name|UnitPreDamaged}}).<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitDestroyed<br />
|args = unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam<br />
|info = Called when a unit is destroyed.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = RenderUnitDestroyed<br />
|args = unitID, unitDefID, unitTeam<br />
|info = Called just before a unit is invalid, after it finishes its death animation. {{new|101.0}}<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitStunned<br />
|args = unitID, unitDefID, unitTeam, stunned<br />
|info = Called when a unit changes its stun status. {{new|99.0}}<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitUnitCollision<br />
|args = colliderID, collideeID<br />
|info = Called when two units collide. Both units must be registered with [[Lua_System#Synced|Script.SetWatchUnit]].<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitFeatureCollision<br />
|args = colliderID, collideeID<br />
|info = Called when a unit collides with a feature. The unit must be registered with [[Lua_System#Synced|Script.SetWatchUnit]] and the feature registered with [[Lua_System#Synced|Script.SetWatchFeature]].<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitCommand<br />
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOpts, cmdTag<br />
|info = Called after when a unit accepts a command, after {{name|AllowCommand}} returns {{value|true}}.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitCmdDone<br />
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOpts, cmdTag<br />
|info = Called when a unit completes a command.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitLoaded<br />
|args = unitID, unitDefID, unitTeam, transportID, transportTeam<br />
|info = Called when a unit is loaded by a transport.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitUnloaded<br />
|args = unitID, unitDefID, unitTeam, transportID, transportTeam<br />
|info = Called when a unit is unloaded by a transport.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitExperience<br />
|args = unitID, unitDefID, unitTeam, experience, oldExperience<br />
|info = Called when a unit gains experience greater or equal to the minimum limit set by calling [[Lua_SyncedCtrl#Other|Spring.SetExperienceGrade]].<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitIdle<br />
|args = unitID, unitDefID, unitTeam<br />
|info = Called when a unit is idle (empty command queue).<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitCloaked<br />
|args = unitID, unitDefID, unitTeam<br />
|info = Called when a unit cloaks.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitDecloaked<br />
|args = unitID, unitDefID, unitTeam<br />
|info = Called when a unit decloaks.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitMoved<br />
|args = ???<br />
|info = ??? Not implemented in base handler<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitMoveFailed<br />
|args = ???<br />
|info = ??? Not implemented in base handler<br />
}}<br />
<br />
{{LuaCallin<br />
|name = StockpileChanged<br />
|args = unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount<br />
|info = Called when a units stockpile of weapons increases or decreases. See {{xtaglink|Gamedev:WeaponDefs|stockpile}}.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitEnteredLos<br />
|args = unitID, unitTeam, allyTeam, unitDefID<br />
|info = Called when a unit enters LOS of an allyteam.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitLeftLos<br />
|args = unitID, unitTeam, allyTeam, unitDefID<br />
|info = Called when a unit leaves LOS of an allyteam.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitEnteredRadar<br />
|args = unitID, unitTeam, allyTeam, unitDefID<br />
|info = Called when a unit enters radar of an allyteam.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitLeftRadar<br />
|args = unitID, unitTeam, allyTeam, unitDefID<br />
|info = Called when a unit leaves radar of an allyteam.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitEnteredAir<br />
|args = ???<br />
|info = ??? Not implemented by base handler<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitLeftAir<br />
|args = ???<br />
|info = ??? Not implemented by base handler<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitEnteredWater<br />
|args = ???<br />
|info = ??? Not implemented by base handler<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitLeftWater<br />
|args = ???<br />
|info = ??? Not implemented by base handler<br />
}}<br />
<br />
{{LuaCallin<br />
|name = UnitSeismicPing<br />
|args = x, y, z, strength, allyTeam, unitID, unitDefID<br />
|info = Called when a unit emits a seismic ping. See {{xtaglink|Gamedev:UnitDefs|seismicSignature}}.<br />
}}<br />
<br />
=== Features ===<br />
{{LuaCallin<br />
|name = FeatureCreated<br />
|args = featureID, allyTeamID<br />
|info = Called when a feature is created.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = FeatureDamaged<br />
|args = featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam<br />
|info = Called when a feature is damaged.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = FeatureDestroyed<br />
|args = featureID, allyTeamID<br />
|info = Called when a feature is destroyed.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = FeatureMoved<br />
|args = ???<br />
|info = ???<br />
}}<br />
<br />
=== Projectiles ===<br />
The following Callins are only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]].<br />
<br />
{{LuaCallin<br />
|name = ProjectileCreated<br />
|args = proID, proOwnerID, weaponDefID<br />
|info = Called when the projectile is created. Note that {{var|weaponDefID}} is missing if the projectile is spawned as part of a burst, but [[Lua_SyncedRead#Projectiles|Spring.GetProjectileDefID]] and [[Lua_SyncedRead#Projectiles|Spring.GetProjectileName]] still work in callin scope using {{var|proID}}.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = ProjectileDestroyed<br />
|args = proID<br />
|info = Called when the projectile is destroyed.<br />
}}<br />
<br />
== Synced Only ==<br />
{{LuaCallin<br />
|name = CommandFallback<br />
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag<br />
|return = {{type|bool}} used, {{type|bool}} finished<br />
|info = Called when the unit reaches an unknown command in its queue (i.e. one not handled by the engine). If no addon returns {{var|used}} as {{value|true}} the command is dropped, if an addon returns {{value|true}}, {{value|true}} the command is removed because it's done, with {{value|true}}, {{value|false}} it's kept in the queue and {{name|CommandFallback}} gets called again on the next slowupdate.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowCommand<br />
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced<br />
|return = {{type|bool}} allow<br />
|info = Called when the command is given, before the unit's queue is altered. The return value is whether it should be let into the queue. The queue remains untouched when a command is blocked, whether it would be queued or replace the queue.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowUnitCreation<br />
|args = unitDefID, builderID, builderTeam, x, y, z, facing<br />
|return = {{type|bool}} allow<br />
|info = Called just before unit is created, the boolean return value determines whether or not the creation is permitted.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowUnitTransfer<br />
|args = unitID, unitDefID, oldTeam, newTeam, capture<br />
|return = {{type|bool}} allow<br />
|info = Called just before a unit is transferred to a different team, the boolean return value determines whether or not the transfer is permitted.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowUnitBuildStep<br />
|args = builderID, builderTeam, unitID, unitDefID, part<br />
|return = {{type|bool}} allow<br />
|info = Called just before a unit progresses its build percentage, the boolean return value determines whether or not the build makes progress.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowFeatureCreation<br />
|args = featureDefID, teamID, x, y, z<br />
|return = {{type|bool}} allow<br />
|info = Called just before feature is created, the boolean return value determines whether or not the creation is permitted.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowFeatureBuildStep<br />
|args = builderID, builderTeam, featureID, featureDefID, part<br />
|return = {{type|bool}} allow<br />
|info = Called just before a feature progresses its build percentage, the boolean return value determines whether or not the progress change is permitted.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowResourceLevel<br />
|args = teamID, res, level<br />
|return = {{type|bool}} allow<br />
|info = Called when a team sets the sharing level of a resource, the boolean return value determines whether or not the sharing level is permitted.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowResourceTransfer<br />
|args = oldTeamID, newTeamID, res, amount<br />
|return = {{type|bool}} allow<br />
|info = Called just before resources are transferred between players, the boolean return value determines whether or not the transfer is permitted.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowStartPosition<br />
|args = clampedX, clampedY, clampedZ, playerID, readyState, rawX, rawY, rawZ<br />
|return = {{type|bool}} allow<br />
|info = {{var|clamped{X,Y,Z}}} are the coordinates clamped into start-boxes, {{var|raw}} is where player tried to place their marker. The {{var|readyState}} can be any one of <br />
* {{value|0}} - player picked a position, <br />
* {{value|1}} - player clicked ready, <br />
* {{value|2}} - player pressed ready OR the game was force-started (player did not click ready, but is now forcibly readied) or <br />
* {{value|3}} - the player failed to load. <br />
* {{new|95.0}} the default 'failed to choose' start-position is the north-west point of their startbox, or (0,0,0) if they do not have a startbox. <br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowDirectUnitControl<br />
|args = unitID, unitDefID, unitTeam, playerID<br />
|return = {{type|bool}} allow<br />
|info = Determines if this unit can be controlled directly in FPS view.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowWeaponTargetCheck<br />
|args = attackerID, attackerWeaponNum, attackerWeaponDefID<br />
|return = {{type|bool}} allowCheck, {{type|bool}} ignoreCheck<br />
|info = Determines if this weapon can automatically generate targets itself. See also {{xtaglink|Gamedev:WeaponDefs|commandFire}} weaponDef tag. The {{var|ignoreCheck}} return value was added in 99.0 to allow ignoring the callin i.e. running normal engine check for this weapon.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowWeaponTarget<br />
|args = attackerID, targetID, attackerWeaponNum, attackerWeaponDefID, defPriority<br />
|return = {{type|bool}} allowed, {{type|number}} newPriority<br />
|info = Controls blocking of a specific target from being considered during a weapon's periodic auto-targeting sweep. The second return value is the new priority for this target (if you don't want to change it, return {{var|defPriority}}). Lower priority targets are targeted first.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowWeaponInterceptTarget<br />
|args = interceptorUnitID, interceptorWeaponID, targetProjectileID<br />
|return = {{type|bool}} allowed<br />
|info = Controls blocking of a specific intercept target from being considered during an {{xtaglink|Gamedev:WeaponDefs|interceptor}} weapon's periodic auto-targeting sweep. Only called for {{var|weaponDefIDs}} registered via [[Lua_System#Synced|Script.SetWatchWeapon]].<br />
}}<br />
<br />
{{LuaCallin<br />
|name = AllowBuilderHoldFire<br />
|args = unitID, unitDefID, action<br />
|return = {{type|bool}} actionAllowed<br />
|info = {{new|98.0}} {{Sourcelinkhash|5a82d750b89e72024bb0bb62cf05ea257737e0ac}} Called when a construction unit wants to "use his nano beams".<br>{{var|action}} is one of following:<br />
* {{value|-1}} Build<br />
* {{value|CMD.REPAIR}} Repair<br />
* {{value|CMD.RECLAIM}} Reclaim<br />
* {{value|CMD.RESTORE}} Restore<br />
* {{value|CMD.RESURRECT}} Resurrect<br />
* {{value|CMD.CAPTURE}} Capture<br />
}}<br />
<br />
{{LuaCallin<br />
|name = Explosion<br />
|args = weaponDefID, px, py, pz, AttackerID, ProjectileID<br />
|return = {{type|bool}} noGfx<br />
|info = Called when an explosion occurs. If it returns {{value|true}} then no graphical effects are drawn by the engine for this explosion.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = TerraformComplete<br />
|args = unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam<br />
|return = {{type|bool}} stop<br />
|info = Called when pre-building terrain levelling terraforms are completed (c.f. {{xtaglink|Gamedev:UnitDefs|levelGround}}). If the return value is {{value|true}} the current build order is terminated.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = MoveCtrlNotify<br />
|args = unitID, unitDefID, unitTeam, data<br />
|return = {{type|bool}} moveCtrlComplete<br />
|info = Enable both [[Lua_MoveCtrl#Options|Spring.MoveCtrl.SetCollideStop]] and [[Lua_MoveCtrl#Options|Spring.MoveCtrl.SetTrackGround]] to enable this call-in, data was supposed to indicate the type of notification but currently never has a value other than {{value|1}} ("unit hit the ground"). The return value determines whether or not the unit should remain script-controlled ({{value|false}}) or return to engine controlled movement ({{value|true}}).<br />
}}<br />
<br />
{{LuaCallin<br />
|name = RecvLuaMsg<br />
|args = msg, playerID<br />
|info = Receives messages from unsynced sent via [[Lua_UnsyncedCtrl#SendLuaMessage|Spring.SendLuaRulesMsg]].<br />
}}<br />
<br />
{{LuaCallin<br />
|name = Load<br />
|args = zip<br />
|info = Called after {{name|GamePreload}} and before {{name|GameStart}}. See [[Lua_SaveLoad#Load_.28_zip_.29_-.3E_nil|Lua_SaveLoad]].<br />
}}<br />
<br />
=== Damage Controllers ===<br />
For the following callins, in addition to being a regular weapon, {{var|weaponDefID}} may be one of the following:<br />
* {{value|-1}} - debris collision, also default of [[Lua_SyncedCtrl#Unit_Control|Spring.AddUnitDamage]]<br />
* {{value|-2}} - ground collision<br />
* {{value|-3}} - object collision<br />
* {{value|-4}} - fire damage<br />
* {{value|-5}} - water damage<br />
* {{value|-6}} - kill damage<br />
* {{value|-7}} - crush damage<br />
<br />
{{LuaCallin<br />
|name = UnitPreDamaged<br />
|args = unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam<br />
|return = {{type|number}} newDamage, {{type|number}} impulseMult<br />
|info = Called before damage is applied to the unit, allows fine control over how much damage and [http://en.wikipedia.org/wiki/Impulse_(physics) impulse] is applied.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = ShieldPreDamaged<br />
|args = proID, proOwnerID, shieldEmitterWeaponNum, shieldCarrierUnitID, bounceProjectile, beamEmitterWeaponNum, beamEmitterUnitID<br />
|return = {{type|bool}} handleCollision<br />
|info = Called before any engine shield-vs-projectile logic executes. If the return value is {{value|true}} the gadget handles the collision event and the engine does not remove the projectile. If the weapon is a hitscan type ([[Gamedev:WeaponDefs#Tag:weaponType|BeamLaser]] or [[Gamedev:WeaponDefs#Tag:weaponType|LightningCanon]]) then {{var|proID}} is {{value|nil}} and {{var|beamEmitterWeaponNum}} and {{var|beamEmitterUnitID}} are populated instead.<br />
}}<br />
<br />
{{LuaCallin<br />
|name = FeaturePreDamaged<br />
|args = featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam<br />
|return = {{type|number}} newDamage, {{type|number}} impulseMult<br />
|info = Called before damage is applied to the feature, allows fine control over how much damage and [http://en.wikipedia.org/wiki/Impulse_(physics) impulse] is applied.<br />
}}<br />
<br />
[[Category: Lua]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Assimp&diff=2179Assimp2016-03-24T16:45:42Z<p>Anarchid: /* Blender Workflow Tutorial */</p>
<hr />
<div>[[Engine_Development|Development]] < [[Game_and_Unit_development|Game Development]] < {{FULLPAGENAME}}<br />
<br />
=Assimp=<br />
Open Asset Import Library (short name: Assimp) is used in Spring for loading a number of common and well supported model formats (.3ds, .dae, .lwo, .blend - currently .obj is parsed by a different code path).<br />
<br />
What Spring supports in its Assimp renderer:<br />
* extended metafile (<code>%modelfilename%.lua</code> next to the modefile)<br />
* still uses tex1 & tex2 texture system of S3O (same shader as S3O)<br />
* 2nd texcoord<br />
* loading of the texture filepaths from the model (don't have to be in <code>unittextures/</code>)<br />
* when texture filepaths aren't included in the model, it searches for <code>%modelfilename%.*</code> & <code>%modelfilename%2.*</code> in <code>unittextures/</code><br />
* special modelpieces `SpringHeight` & `SpringRadius`<br />
* {{new|95.0}} allow modellers to work around {{mantis|3552}} (differing axes conventions between software) by recognizing a number of new piece-table keys as follows<br />
<br />
For the root piece:<br />
* "xaxis" = float3, "yaxis" = float3, "zaxis" = float3 (determine global orientation of model)<br />
For all pieces:<br />
* "rotAxisSigns" = float3 (determines direction of script-applied rotations around each axis)<br />
* "rotAxisMap" = number (currently can only be 0=XYZ or 3=XZY, determines coordinate conversion)<br />
<br />
=Assimp Textures=<br />
See [[3DModels:Textures#Textures_-_Assimp_Model_Formats_.28DAE.2CMDL.2CMD3_and_others_except_OBJ.29 |3DModels:Textures (Assimp Section)]]<br />
<br />
=Blender Workflow Tutorial=<br />
This is a stub containing a simple outline of a Blender workflow.<br />
<br />
# Open an existing Blender model or import a different format through the File menu (File > Import).<br />
# In the 3D view, drag out the secret panel from the right. [[File:3-12-2013 5-02-21 PM.png‎‎|secret panel]]<br />
# In that panel, select Display > Shading > GLSL. [[File:3-12-2013 5-02-04 PM.png‎‎|display settings]]<br />
# Make sure you have a lamp in your scene while in this mode or your model will be dark.<br />
# Applying texture: <br />
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.<br />
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.<br />
## Hit A to select all your faces.<br />
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.<br />
## If you don't see any faces you'll need to add the UVMap to a new texture:<br />
### In the Properties view click on Textures (checkerboard icon).<br />
### Click on Add New Texture (plus icon).<br />
### Select Type = Image or Movie.<br />
### Under Image, click on the image icon and choose your image file.<br />
### Under Mapping, select Coordinates = UV.<br />
### Under Influence > Diffuse, check Color and make sure it's 1.00.<br />
## To add a normalmap:<br />
### Repeat steps 5.5.1 to 5.5.5.<br />
### Under Image Sampling, check Normal Map.<br />
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.<br />
## You'll need to do this for each piece.<br />
# Piece hierarchy:<br />
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.<br />
## <strike>Make sure all the pieces are descending from one single piece.</strike> This is no longer necessary but is still good practice. Spring will now place all your pieces into one root piece for you, regardless.<br />
# Setting piece origins:<br />
## Select a piece.<br />
## Place the 3D cursor where you want the origin to be (left-click).<br />
## Click on Object > Transform > Origin to 3D Cursor.<br />
## You can now rotate your pieces:<br />
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.<br />
### Rotate.<br />
## Do this for all your pieces.<br />
# Preparing for Spring (this may or may not apply depending on how assimp handles your model.):<br />
## Ensure that the scales for each object in your scene are uniform (that is, x, y, and z scales are equal to each other). A quick way to ensure that is select all (a) and apply scale (ctrl+a -> scale).<br />
# Save your model.<br />
# Select all the pieces of your model, ignore the lamp.<br />
# Click on File > Export > Collada.<br />
# Check "Export Only Selected" and export.<br />
# The dae file will be used as your object.<br />
<br />
<br />
<br />
<br />
<br />
[[Category:3D Models]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Gamedev:WeaponDefs&diff=8806Gamedev:WeaponDefs2015-11-19T20:35:49Z<p>Anarchid: /* Collision & Avoidance */</p>
<hr />
<div>[[Gamedev:Main|Development]] < [[Gamedev:Main]] < {{FULLPAGENAME}}<br />
<br />
==Location==<br />
WeaponDef files are .lua files stored in the <code>Weapons/</code> directory of a Spring Game. Alternatively they can be integrated into [[Gamedev:UnitDefs|UnitDefs]].<br />
<br />
==Purpose==<br />
WeaponDef files have one purpose; to define the properties of weapons. They are the main description file for what attributes your weapon should have and how it should behave. Since version 100.0, Spring will record a warning whenever it finds an unknown tag.<br />
<br />
==Source==<br />
The engine source code which loads the tags from these files is viewable here:<br />
<br />
* {{sourcelink|file=rts/Sim/Weapons/WeaponDef.cpp}}<br />
<br />
==Data Types==<br />
{{DataTypes}}<br />
<br />
==Details==<br />
There follows a comprehensive (certain deprecated tags are not present) list of the tags available, their data type, default value and a brief description of what they do. Bear in mind that the source code linked above is the ultimate reference when dealing with these tags. <br />
<br />
In lua tables keys (i.e. the tags) should be lower case, here they are represented in camelCase for readability. In your files you may use the <code>lowerkeys</code> function on your final table to ensure the keys are properly cased.<br />
<br />
It is usual to name the returned WeaponDef table the internal <code>weaponName</code> desired for the weapon.<br />
<br />
===Common===<br />
The following tags are common to all or at least a majority of '''WeaponTypes''', depending on the tag.<br />
<br />
====General====<br />
{{tag<br />
|name = weaponType<br />
|type = string<br />
|default = "Cannon"<br />
|description = Spring has 14 '''WeaponTypes''' which provide game developers with basic behaviours which they can customise to an extent with the '''WeaponDef''' tags. Some tags are specific to certain '''WeaponTypes''' and not implemented for others, [https://docs.google.com/spreadsheet/ccc?key=0Am5BbZxm93S9dEZXc1Q4dXR4TFRYTFM4NlR4OFJFdWc#gid=0 this two-way table] indicates which tags work for which types.}} The possible values are:<br />
* [[#AircraftBomb|AircraftBomb]]<br />
* [[#BeamLaser|BeamLaser]]<br />
* [[#Cannon|Cannon]]<br />
* [[#DGun|Dgun]]<br />
* [[#EmgCannon|EmgCannon]]<br />
* [[#Flame|Flame]]<br />
* [[#LaserCannon|LaserCannon]]<br />
* [[#LightningCannon|LightningCanon]]<br />
* [[#Melee|Melee]]<br />
* [[#MissileLauncher|MissileLauncher]]<br />
* [[#Rifle|Rifle]]<br />
* [[#Shield (WeaponType)|Shield]]<br />
* [[#StarburstLauncher|StarburstLauncher]]<br />
* [[#TorpedoLauncher|TorpedoLauncher]]<br />
<br />
{{tag<br />
|name = name<br />
|type = string<br />
|default = "Weapon"<br />
|description = The descriptive name of the weapon as listed in FPS mode.}}<br />
<br />
{{tag<br />
|name = turret<br />
|type = bool<br />
|default = false<br />
|description = Does the unit aim within an arc (up-to and including full 360° turret traverse) or always aim along the owner's heading?}}<br />
<br />
{{tag<br />
|name = noSelfDamage<br />
|type = bool<br />
|default = false<br />
|description = Can the weapon's explosion damage the unit which fires it? Useful for preventing bombers with high-yield weapons destroying themselves.}}<br />
<br />
{{tag<br />
|name = impactOnly<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon only deal damage through direct hits and not 'splash' damage through {{taglink|areaOfEffect}}?}}<br />
<br />
{{tag<br />
|name = noExplode<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon explode on impact with a target or continue through? Note that these weapons will do damage every single frame they are inside the [[Gamedev:CollisionVolumes|collision volume]] of an object, underground or under water, massively multiplying their damage.}}<br />
<br />
{{tag<br />
|name = burnblow<br />
|type = bool<br />
|default = false<br />
|special = lua: selfExplode<br />
|description = Does the weapon explode when it reaches its maximum range or continue on its path? The name is an [[OTAism]].}}<br />
<br />
{{tag<br />
|name = range<br />
|type = float<br />
|default = 10.0<br />
|description = The maximum range in [[elmo]]s that the weapon can fire at.}}<br />
<br />
{{tag<br />
|name = weaponVelocity<br />
|type = float<br />
|default = 0.0<br />
|description = The velocity in [[elmo]]s per second of the weapon projectile. Since 99.0 <code>maxVelocity</code> is a synonym.}}<br />
<br />
{{tag<br />
|name = reloadTime<br />
|type = float<br />
|default = 1.0<br />
|description = The time in seconds between shots fired.}}<br />
<br />
{{tag<br />
|name = metalPerShot<br />
|type = float<br />
|default = 0.0<br />
|description = 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 {{taglink|stockpile}} weapon will cost to build.}}<br />
<br />
{{tag<br />
|name = energyPerShot<br />
|type = float<br />
|default = 0.0<br />
|description = Energy used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a {{taglink|stockpile}} weapon will cost to build.}}<br />
<br />
{{tag<br />
|name = myGravity<br />
|type = float<br />
|default = 0.0<br />
|description = Overrides the map gravity for ballistic weapons. The default of <code>0.0</code> disables the tag in favour of map gravity.}}<br />
<br />
{{tag<br />
|name = fireStarter<br />
|type = float<br />
|default = 0.0<br />
|description = The percentage chance (<code>0.0</code> to <code>100.0</code>) of the weapon setting fire to static map features on impact.}}<br />
<br />
{{tag<br />
|name = cameraShake<br />
|type = float<br />
|default = damage (0.0 for paralyzers)<br />
|description = Passed to the [[LuaCallinReturn#Game_Events:|ShockFront() callin]] as the first argument. Intended as a means to make the camera shake if in range of detonation.}}<br />
<br />
{{tag<br />
|name = stockpile<br />
|type = bool<br />
|default = false<br />
|description = Does each round of the weapon have to be built and stockpiled by the player? Will only correctly function for the first of each stockpiled weapons a unit has.}}<br />
<br />
{{tag<br />
|name = stockpileTime<br />
|type = float<br />
|default = reloadTime<br />
|description = The time in seconds taken to stockpile one round of the weapon.}}<br />
<br />
{{tag<br />
|name = interceptedByShieldType<br />
|type = int<br />
|default = Depends on {{taglink|weaponType}}<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of shields that can intercept this weapon. Each digit of binary that is set to one means that a shield with the corresponding digit in its {{taglink|interceptType}} will intercept this weapon. A value of <code>0</code> means that no shields will intercept the weapon. The defaults are as follows:<br />
* <code>0</code> - [[#DGun]]<br />
* <code>1</code> - [[#Cannon]] and [[#EmgCannon]]<br />
* <code>2</code> - [[#LaserCannon]] and [[#BeamLaser]]<br />
* <code>4</code> - [[#MissileLauncher]] and [[#StarburstLauncher]]<br />
* <code>8</code> - [[#AircraftBomb]]<br />
* <code>16</code> - [[#Flame]]<br />
* <code>32</code> - [[#TorpedoLauncher]]<br />
* <code>64</code> - [[#LightningCannon]]<br />
* <code>128</code> - [[#Rifle]]<br />
* <code>256</code> - [[#Melee]]<br />
(See [[Shield Interception Tag Use]]).}}<br />
<br />
====Collision & Avoidance====<br />
<br />
{{tag<br />
|name = avoidGround<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if terrain blocks the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidFriendly<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if a friendly unit is in the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidFeature<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if a static map feature is in the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidNeutral<br />
|type = bool<br />
|default = false<br />
|description = Should the weapon avoid firing if a neutral unit is in the line of fire?}}<br />
<br />
{{tag<br />
|name = collideEnemy<br />
|type = bool<br />
|default = true<br />
|special = lua: noEnemyCollide<br />
|description = Does the weapon projectile collide with enemy units or pass through?}}<br />
<br />
{{tag<br />
|name = collideFriendly<br />
|type = bool<br />
|default = true<br />
|special = lua: noFriendlyCollide<br />
|description = Does the weapon projectile collide with friendly units or pass through?}}<br />
<br />
{{tag<br />
|name = collideFeature<br />
|type = bool<br />
|default = true<br />
|special = lua: noFeatureCollide<br />
|description = Does the weapon projectile collide with static map features or pass through?}}<br />
<br />
{{tag<br />
|name = collideNeutral<br />
|type = bool<br />
|default = true<br />
|special = lua: noNeutralCollide<br />
|description = Does the weapon projectile collide with neutral units or pass through?}}<br />
<br />
{{tag<br />
|name = collideGround<br />
|type = bool<br />
|default = true<br />
|special = lua: noGroundCollide<br />
|description = Does the weapon projectile collide with terrain or pass through?}}<br />
<br />
{{tag<br />
|name = collisionSize<br />
|type = float<br />
|default = 0.05 (0.5 for [[#Flame]] and [[#LaserCannon]], 10.0 for [[#Dgun]])<br />
|description = Modifies visual size of EMG and Flame projectiles, and physical size '''only''' for hitscan interceptor weapons (e.g. antinuke lasers). [[https://github.com/spring/spring/blob/3034e5f5a8f5b9fb4624a97f7a85cb5c90457725/rts/Sim/Projectiles/WeaponProjectiles/WeaponProjectile.cpp#L250 1]][[https://github.com/spring/spring/blob/master/rts/Sim/Misc/CollisionHandler.cpp#L33 2]]}}<br />
<br />
====Targeting & Accuracy====<br />
{{tag<br />
|name = commandFire<br />
|type = bool<br />
|default = false<br />
|description = Determines if the weapon will automatically fire on enemy units in range or only when manually ordered to attack.}}<br />
<br />
{{tag<br />
|name = canAttackGround<br />
|type = bool<br />
|default = true<br />
|description = Determines if the weapon can be force-fired on ground positions or only fire on targeted units.}}<br />
<br />
{{tag<br />
|name = waterWeapon<br />
|type = bool<br />
|default = false<br />
|description = Determines if the weapon can pass through water and target underwater units.}}<br />
<br />
{{tag<br />
|name = fireSubmersed<br />
|type = bool<br />
|default = waterWeapon<br />
|description = Determines if the weapon can fire whilst underwater.}}<br />
<br />
{{tag<br />
|name = targetBorder<br />
|type = float<br />
|default = 0.0 (1.0 for [[#Melee]])<br />
|description = Controls whether the weapon aims for the centre or the edge of its target's [[Gamedev:CollisionVolumes|collision volume]]. Clamped between <code>-1.0</code> - target the far border, and <code>1.0</code> - target the near border.}}<br />
<br />
{{tag<br />
|name = cylinderTargeting<br />
|type = float<br />
|default = 0.0 (1.0 for [[#Melee]])<br />
|description = Controls whether the weapon range is calculated in a sphere or a cylinder. The height of the cylinder is determined by the value of this tag multiplied by the {{taglink|range}}. Clamped between <code>0.0</code> and <code>128.0</code>.}}<br />
<br />
{{tag<br />
|name = tolerance<br />
|type = float<br />
|default = 3000.0 (+/- ~18 degrees)<br />
|description = The amount (in [[Gamedev:UnitsOfMeasurement#Angular|cau]]) to which the weapon's "real" aim can be off while the weapon will still be able to fire accurately at the target. For {{taglink|turret|false}} or {{taglink|fixedLauncher|true}} weapons this determines in what arc the unit will fire.}}<br />
<br />
{{tag<br />
|name = fireTolerance<br />
|type = float<br />
|default = 32768.0 (+/- 180 degrees)<br />
|special = {{new|99.0}}<br />
|description = Final check to prevent weapons from shooting sideways. If a weapon is about to fire but the difference between its old aim and requested aim is greater than this angle (in [[Gamedev:UnitsOfMeasurement#Angular|cau]]) then it will not fire.}}<br />
<br />
{{tag<br />
|name = allowNonBlockingAim<br />
|type = bool<br />
|default = false<br />
|special = {{new|99.0}}<br />
|description = When enabled it makes [[Animation-LuaCallins#Weapons|AimWeapon()]] script calls non-blocking (still the {{taglink|fireTolerance}} tag might prevent the weapon firing). This is very useful for fast units that need to re-target often.}}<br />
<br />
{{tag<br />
|name = targetMoveError<br />
|type = float<br />
|default = 0.0<br />
|description = 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.}}<br />
<br />
{{tag<br />
|name = leadLimit<br />
|type = float<br />
|default = -1.0<br />
|description = Limits the maximum distance a unit will lead a target. The default of <code>-1</code> allows an infinite distance.}}<br />
<br />
{{tag<br />
|name = leadBonus<br />
|type = float<br />
|default = 0.0<br />
|description = Controls how experience boosts the weapon's target leading. Is multiplied with the unit's experience and added to the {{taglink|leadLimit}}.}}<br />
<br />
{{tag<br />
|name = predictBoost<br />
|type = float<br />
|default = 0.0 (0.5 for {{taglink|burnblow|true}} weapons)<br />
|description = Controls how well the weapon predicts unit speeds. Works in a similar way to {{taglink|targetMoveError}} except that it is 1-dimensional. This tag spreads the shots in a line based on the direction of the target whereas {{taglink|targetMoveError}} spreads the shots all around based on the movement.}}<br />
<br />
{{tag<br />
|name = heightMod<br />
|type = float<br />
|default = 0.2 (0.8 for [[#Cannon]], 1.0 for [[#BeamLaser]] and [[#LightningCannon]])<br />
|description = Changes the spherical weapon range into an ellipsoid. Values above <code>1.0</code> mean the weapon cannot target as high as it can far, values below <code>1.0</code> mean it can target higher than it can far. For example <code>0.5</code> would allow the weapon to target twice as high as far.}}<br />
<br />
{{tag<br />
|name = proximityPriority<br />
|type = float<br />
|default = 1.0<br />
|description = Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets.}}<br />
<br />
{{tag<br />
|name = accuracy<br />
|type = float<br />
|default = 0.0<br />
|description = How accurate the weapon is. Lower values are more accurate. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high value will probably still hit. If a target is very far away, even a very low value will likely cause the weapon to miss.}}<br />
<br />
{{tag<br />
|name = movingAccuracy<br />
|type = float<br />
|default = accuracy<br />
|description = A weapon's {{taglink|accuracy}} whilst the owning unit is moving.}}<br />
<br />
{{tag<br />
|name = sprayAngle<br />
|type = float<br />
|default = 0.0<br />
|description = How wide the the angle of a burst from a [[#Bursts|burst weapon]] can be. Very similar to {{taglink|accuracy}}, except that this tag affects each projectile in a burst, whilst the former does not.}}<br />
<br />
{{tag<br />
|name = ownerExpAccWeight<br />
|type = float<br />
|default = 0.0 (See description)<br />
|description = A multiplier to {{taglink|accuracy}} and {{taglink|sprayAngle}} that reduces inaccuracy as a units experience increases. Defaults are as follows:<br />
* <code>0.9</code> - [[#Cannon]], [[#Rifle]]<br />
* <code>0.7</code> - [[#LaserCannon]], [[#BeamLaser]], [[#StarburstLauncher]]<br />
* <code>0.5</code> - [[#MissileLauncher]], [[#LightningCannon]], [[#EmgCannon]], [[#DGun]]<br />
* <code>0.2</code> - [[#Flame]]<br />
}}<br />
<br />
{{tag<br />
|name = targetable<br />
|type = int<br />
|default = 0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapon that can intercept this weapon. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptor}} tag will intercept this weapon. Instant-hitting weapons such as [[#BeamLaser]], [[#LightningCannon]] and [[#Rifle]] cannot be targeted.<br />
}}<br />
<br />
{{tag<br />
|name = interceptor<br />
|type = int<br />
|default = 0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this weapon can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|targetable}} tag will be intercepted by this weapon.<br />
}}<br />
<br />
{{tag<br />
|name = interceptSolo<br />
|type = bool<br />
|default = true<br />
|special = {{new|92.0}} <br />
|description = If <code>true</code> no other interceptors may target the same projectile.<br />
}}<br />
<br />
{{tag<br />
|name = coverage<br />
|type = float<br />
|default = 0.0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = The radius in [[elmo]]s within which an {{taglink|interceptor}} weapon will fire on {{taglink|targetable}} weapons.<br />
}}<br />
<br />
====Bouncing====<br />
<br />
{{tag<br />
|name = waterBounce<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon bounce on water impacts?}}<br />
<br />
{{tag<br />
|name = groundBounce<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon bounce on ground impacts?}}<br />
<br />
{{tag<br />
|name = bounceSlip<br />
|type = float<br />
|default = 1.0<br />
|description = The decimal-percentage amount of horizontal velocity a projectile keeps when it bounces.}}<br />
<br />
{{tag<br />
|name = bounceRebound<br />
|type = float<br />
|default = 1.0<br />
|description = The decimal-percentage amount of vertical velocity a projectile keeps when it bounces.}}<br />
<br />
{{tag<br />
|name = numBounce<br />
|type = int<br />
|default = -1<br />
|description = The number of times the weapon will bounce on impact before exploding. The default value of <code>-1</code> allows infinite bounces (at least until velocity reaches 0).}}<br />
<br />
====Area Of Effect, Impulse & Cratering====<br />
<br />
{{tag<br />
|name = areaOfEffect<br />
|type = float<br />
|default = 8.0 * 0.5<br />
|special = lua: damageAreaOfEffect<br />
|description = The ''diameter'' in [[elmo]]s in which the weapons explosion will cause damage.}}<br />
<br />
{{tag<br />
|name = craterAreaOfEffect<br />
|type = float<br />
|default = areaOfEffect * 0.5<br />
|description = The ''radius'' in [[elmo]]s in which the weapons explosion will cause terrain cratering. Behaviour changed slightly in 98.0 as previously craters were 1.5x {{taglink|craterAreaOfEffect}} whilst decals were 1.0x, they are now both the same size.}}<br />
<br />
{{tag<br />
|name = edgeEffectiveness<br />
|type = float<br />
|default = 0.0<br />
|description = Determines what percent of a weapon's maximum damage value will be applied to units within the weapon's {{taglink|areaOfEffect}}. Falls off from the epicentre according to the formula <code>damageApplied = damage * [(areaOfEffect - distToUnit) / (areaOfEffect - (distToUnit * edgeEffectiveness))]</code>, a graph of the function for various values is available [[Media:EdgeEffectiveness.png|here]].}}<br />
<br />
{{tag<br />
|name = explosionSpeed<br />
|type = float<br />
|default = See description<br />
|description = The speed at which the weapon's explosion propagates from the epicentre. The default is calculated by this complex formula: <code>defExpSpeed = {8.0 + [max(30.0, default_damage / 20.0) * 2.5]} / {9.0f + [sqrt(max(30.0, default_damage / 20.0f)) * 0.7]} * 0.5</code>.}}<br />
<br />
{{tag<br />
|name = impulseFactor<br />
|type = float<br />
|default = 1.0<br />
|description = A multiplier to the impulse given to units within the explosion {{taglink|areaOfEffect}}, which is otherwise equal to the damage dealt after {{taglink|edgeEffectiveness}} is taken into account. For [[#Melee]] weapons this is instead multiplied by the owning unit's mass (See [[Gamedev:UnitDefs#Tag:mass|Gamedev:UnitDefs]]).}}<br />
<br />
{{tag<br />
|name = impulseBoost<br />
|type = float<br />
|default = 0.0<br />
|description = A constant amount added to the weapon's impulse, regardless of distance from the epicentre or the damage potential of the explosion, prior to the application of {{taglink|impulseFactor}}}}<br />
<br />
{{tag<br />
|name = craterMult<br />
|type = float<br />
|default = impulseFactor<br />
|description = A multiplier to depth of terrain crater the weapon's explosion will create, which is otherwise based on the damage potential.}}<br />
<br />
{{tag<br />
|name = craterBoost<br />
|type = float<br />
|default = 0.0<br />
|description = A constant amount, added to the weapon's cratering depth before the application of {{taglink|craterMult}}.}}<br />
<br />
====Bursts====<br />
<br />
{{tag<br />
|name = burst<br />
|type = int<br />
|default = 1<br />
|special = lua: salvoSize<br />
|description = How many shots to fire per burst.<br />
}}<br />
<br />
{{tag<br />
|name = burstRate<br />
|type = float<br />
|default = 0.1<br />
|special = lua: salvoDelay<br />
|description = The time in seconds between shots in a burst. Note that {{taglink|reloadTime}} starts to count down from the ''first'' round fired, not the last so if <code>reloadTime < burst * burstRate</code> the weapon will fire continuously.<br />
}}<br />
<br />
{{tag<br />
|name = projectiles<br />
|type = int<br />
|default = 1<br />
|description = How many projectiles released per shot (shotgun style). e.g. a weapon with {{taglink|burst|5}}, {{taglink|burstRate|0.5}} and {{taglink|projectiles|2}} will shoot 5 lots of 2 for 10 projectiles total, with gaps of 0.5 seconds, before waiting for {{taglink|reloadTime}}. Best used in conjunction with {{taglink|sprayAngle}} or changing the firing piece using [[Animation-LuaCallins#Weapons|ShotX]] as otherwise they'll all be clumped in one shot.<br />
}}<br />
<br />
====Paralyzing====<br />
{{tag<br />
|name = paralyzer<br />
|type = bool<br />
|default = false<br />
|description = Is the weapon a paralyzer? If <code>true</code> the weapon only stuns enemy units and does not cause damage in the form of lost hit-points.<br />
}}<br />
<br />
{{tag<br />
|name = paralyzeTime<br />
|type = int<br />
|default = 10<br />
|special = lua: damages.paralyzeDamageTime<br />
|description = Determines the maximum length of time in seconds that the target will be paralyzed. The timer is restarted every time the target is hit by the weapon. Cannot be less than <code>0</code>.<br />
}}<br />
<br />
====Dynamic Damage====<br />
The following set of tags allow for a weapon's damage potential to vary with the distance to its target.<br />
<br />
{{tag<br />
|name = dynDamageExp<br />
|type = float<br />
|default = 0.0<br />
|description = Exponent of the range-dependent damage formula, the default of <code>0.0</code> disables dynamic damage, <code>1.0</code> means linear scaling, <code>2.0</code> quadratic and so on.<br />
}}<br />
<br />
{{tag<br />
|name = dynDamageMin<br />
|type = float<br />
|default = 0.0<br />
|description = The minimum floor value that range-dependent damage can drop to.<br />
}}<br />
<br />
{{tag<br />
|name = dynDamageRange<br />
|type = float<br />
|default = 0.0<br />
|description = If set to non-zero values the weapon will use this value in the range-dependant damage formula instead of the actual {{taglink|range}}. <br />
}}<br />
<br />
{{tag<br />
|name = dynDamageInverted<br />
|type = bool<br />
|default = false<br />
|description = If <code>true</code> the damage curve is inverted i.e. the weapon does more damage at greater ranges as opposed to less.<br />
}}<br />
<br />
====Sounds====<br />
{{tag<br />
|name = soundTrigger<br />
|type = bool<br />
|default = false (true for [[#Melee]], [[#Rifle]] and non-beamBurst [[#BeamLaser]])<br />
|description = Does the weapon play {{taglink|soundStart}} only once for each salvo (<code>true</code>) or for every round in a burst (<code>false</code>)?}}<br />
<br />
{{tag<br />
|name = soundStart<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon fires.}}<br />
<br />
{{tag<br />
|name = soundHitDry<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with solid ground. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}<br />
<br />
{{tag<br />
|name = soundHitWet<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with water. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}<br />
<br />
====Visuals====<br />
<br />
{{tag<br />
|name = cegTag<br />
|type = string<br />
|default = ""<br />
|description = The name, without prefixes, of a [[CEG]] to be emitted by the projectile each frame.<br />
}}<br />
<br />
{{tag<br />
|name = intensity<br />
|type = float<br />
|default = 0.9 (0.2 for [[#Cannon]])<br />
|description = Alpha transparency for non-3D model projectiles. Lower values are more opaque, but <code>0.0</code> will cause the projectile to disappear entirely.<br />
}}<br />
<br />
{{tag<br />
|name = model<br />
|type = string<br />
|default = ""<br />
|description = The filename of a 3D model to use when rendering the projectile. Note that only the root piece of a projectile model is rendered. Currently only for [[#Cannon]], [[#LaserCannon]], [[#MissileLauncher]], [[#StarburstLauncher]] and [[#TorpedoLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = explosionScar<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon's explosion leave a scar decal on the ground? For all types except [[#Melee]] and [[#Rifle]].<br />
}}<br />
<br />
{{tag<br />
|name = alwaysVisible<br />
|type = bool<br />
|default = false<br />
|description = If <code>true</code> the weapon is always rendered regardless of whether or not it is in LOS range of a player's units.<br />
}}<br />
<br />
{{tag<br />
|name = rgbColor<br />
|type = float[3]<br />
|default = {1.0, 0.0, 0.0} (See Description)<br />
|description = The primary colour for sprite rendering weapons. Additional defaults are as follows:<br />
* [[#Cannon]] - <code>{1.0, 0.5, 0.0}</code><br />
* [[#EmgCannon]] - <code>{0.9, 0.9, 0.2}</code><br />
}}<br />
<br />
{{tag<br />
|name = explosionGenerator<br />
|type = string<br />
|default = ""<br />
|description = The name of a [[CEG]], with <code>custom:</code> prefix, to spawn as the weapon's explosion. Does not currently work for [[#Melee]] and [[#Rifle]].<br />
}}<br />
<br />
{{tag<br />
|name = bounceExplosionGenerator<br />
|type = string<br />
|default = ""<br />
|description = For weapons which can use {{taglink|groundBounce|true}}, the name of a [[CEG]], with <code>custom:</code> prefix, to spawn when weapon the bounces.<br />
}}<br />
<br />
{{tag<br />
|name = texture1<br />
|type = string<br />
|default = ""<br />
|description = The projectile texture for [[#AircraftBomb]], [[#Cannon]], [[#EmgCannon]], [[#Flame]]; beam texture for [[#LaserCannon]], [[#BeamLaser]], [[#LightningCannon]]; flare texture for [[#MissileLauncher]], [[#StarburstLauncher]] and dome texture for the [[#Shield]].<br />
}}<br />
<br />
{{tag<br />
|name = texture2<br />
|type = string<br />
|default = ""<br />
|description = The end-of-beam texture for [[#LaserCannon]], [[#BeamLaser]] and {{taglink|smoketrail}} texture for [[#MissileLauncher]], [[#StarburstLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = texture3<br />
|type = string<br />
|default = ""<br />
|description = Flare texture for [[#BeamLaser]], or muzzle texture if {{taglink|largeBeamLaser|true}}. Also used as the flame texture for [[#StarburstLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = texture4<br />
|type = string<br />
|default = ""<br />
|description = Flare texture for [[#BeamLaser]] with {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
===AircraftBomb===<br />
Drops a ballistic projectile at the same movement vector as the unit itself. Intended only for aircraft. Visually drawn as a billboarded sprite as used by the [[#Cannon]], but more commonly used with a 3D model.<br />
<br />
There are no tags specific to this '''WeaponType'''<br />
<br />
====AircraftBomb Visuals====<br />
<br />
When not using a {{taglink|model}}, the AircraftBomb is the same as [[#Cannon Visuals]].<br />
<br />
===BeamLaser===<br />
An instant-hit weapon which spawns a beam and does a portion of its total damage each frame. Cannot be [[Animation-LuaCallouts#Effects|script emitted]] if it has a {{taglink|beamTime}} longer than one frame. Visually drawn as a [http://en.wikipedia.org/wiki/Star_Trek Star Trek] Phaser-style laser weapon. The {{taglink|largeBeamLaser}} tag allows changing the visual effect of the laser, such as using a tileable, scrolling texture without changing the behaviour.<br />
<br />
{{tag<br />
|name = minIntensity<br />
|type = float<br />
|default = 0.0<br />
|description = The minimum percentage the weapon's damage can fall-off to over its range. Setting to <code>1.0</code> will disable fall off entirely. Unrelated to the visual-only {{taglink|intensity}} tag.<br />
}}<br />
<br />
{{tag<br />
|name = beamTime<br />
|type = float<br />
|default = 1.0<br />
|description = How long in seconds to fire the laser before waiting for {{taglink|reloadTime}} to start. Damage is distributed over the duration of the {{taglink|beamTime}}, and the weapon will aim to hit the target when the beam is in the middle of its {{taglink|beamTime}} (i.e. using prediction).<br />
}}<br />
<br />
{{tag<br />
|name = beamBurst<br />
|type = bool<br />
|default = false<br />
|description = Makes the laser fire a burst of beams that are all aimed towards the target (instead of aimed with the piece). A [[#BeamLaser]] can do its full damage with every shot if {{taglink|beamBurst}} is enabled. Disables {{taglink|beamTime}} in favour of the [[#Bursts|burst tags]].<br />
}}<br />
<br />
{{tag<br />
|name = sweepFire<br />
|type = bool<br />
|default = false<br />
|description = Makes the laser continue firing while it aims for a new target, 'sweeping' across the terrain. Reimplemented in 95.0, still has no script interaction so use with care. Respects {{taglink|reloadTime}} constraint but not much else.<br />
}}<br />
<br />
====BeamLaser Visuals====<br />
<br />
See also {{taglink|thickness}} and {{taglink|coreThickness}}.<br />
<br />
{{tag<br />
|name = beamTTL<br />
|type = int<br />
|default = 0<br />
|description = The time in frames for which the laser beam remains visible.<br />
}}<br />
<br />
{{tag<br />
|name = beamDecay<br />
|type = float<br />
|default = 1.0<br />
|description = How fast the beam fades out. Each frame the {{taglink|intensity}} is multiplied by this value.<br />
}}<br />
<br />
{{tag<br />
|name = laserFlareSize<br />
|type = float<br />
|default = 15.0<br />
|description = Determines the size of the firing flare.<br />
}}<br />
<br />
{{tag<br />
|name = largeBeamLaser<br />
|type = bool<br />
|default = false<br />
|description = Changes the visual effect allowing tiling and scrolling of the texture and a pulsating firing flare.<br />
}}<br />
<br />
{{tag<br />
|name = tileLength<br />
|type = float<br />
|default = 200.0<br />
|description = Defines the length before the texture used is repeated (tiled). Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
{{tag<br />
|name = scrollSpeed<br />
|type = float<br />
|default = 5.0<br />
|description = Controls how fast the texture scrolls. Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
{{tag<br />
|name = pulseSpeed<br />
|type = float<br />
|default = 1.0<br />
|description = Controls how fast the pulsating effect at the start of the beam is. Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
===Cannon===<br />
The default '''WeaponType'''. Fires a ballistic projectile, for the best result (without under/overshooting) the {{taglink|weaponVelocity}} should be set so as to give an elevation of 45° when firing at the maximum {{taglink|range}}. Substituting the angle into the [http://en.wikipedia.org/wiki/Trajectory#Range_and_height trajectory equation] and rearranging, we get: <br />
<code><pre>weaponVelocity = √(range * g)</pre></code> <br />
where <code>g</code> is the map gravity, usually around <code>120</code> for most Spring maps (You can use the {{taglink|myGravity}} tag if you want to be exact). Visually drawn as a billboarded sprite or 3D model. <br />
<br />
{{tag<br />
|name = highTrajectory<br />
|type = int<br />
|default = 2<br />
|description = Can this weapon be fired in a high trajectory (>45° angle). Can be <code>0</code> - low trajectory only, <code>1</code> - high trajectory only or <code>2</code> - enables a high/low toggle button on the unit.<br />
}}<br />
<br />
{{tag<br />
|name = heightBoostFactor<br />
|type = float<br />
|default = -1.0<br />
|description = Controls the boost given to {{taglink|range}} by high terrain. Values > <code>1.0</code> result in increased range, <code>0.0</code> means the cannon has fixed range regardless of height difference to target. Any value < <code>0.0</code> (i.e. the default value) result in an automatically calculated value based on {{taglink|range}} and theoretical maximum range.<br />
}}<br />
<br />
====Cannon Visuals====<br />
<br />
{{tag<br />
|name = size<br />
|type = float<br />
|default = 2.0 + min(default_damage * 0.0025, {{taglink|areaOfEffect}} * 0.1)<br />
|description = The drawing radius of the billboarded sprite. Also for [[#AircraftBomb Visuals]], [[#EmgCannon Visuals]] (default: <code>3.0</code>) and [[#Flame Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = colorMap<br />
|type = string<br />
|default = ""<br />
|description = A set of RGB colours to transition between over the projectile's lifetime. Can be given as a string of RGB digits or an image filename (See [[CColorMap]]). Also for [[#Flame Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = sizeDecay<br />
|type = float<br />
|default = 0.0<br />
|description = How quickly each particle of the Cannon shot decays in size.<br />
}}<br />
<br />
{{tag<br />
|name = alphaDecay<br />
|type = float<br />
|default = 1.0<br />
|description = How quickly each particle of the Cannon shot fades out.<br />
}}<br />
<br />
{{tag<br />
|name = separation<br />
|type = float<br />
|default = 0.0<br />
|description = The distance between each particle of the Cannon shot.<br />
}}<br />
<br />
{{tag<br />
|name = noGap<br />
|type = bool<br />
|default = true<br />
|description = Switch between the distance between particles being proportional to the size of the two particles (<code>true</code>) or proportional to the size of the first particle (<code>false</code>). <br />
}}<br />
<br />
{{tag<br />
|name = stages<br />
|type = int<br />
|default = 5<br />
|description = The number of particles in each Cannon shot.<br />
}}<br />
<br />
===DGun===<br />
Fires a line-of-sight or ballistic projectile (selected via the {{taglink|gravityAffected}} tag). Visually represented by a fireball effect that cannot be customised, however it can be replaced by a 3D model. The name and visual effect are [[OTAism]]s.<br />
<br />
{{tag<br />
|name = gravityAffected<br />
|type = bool<br />
|default = false<br />
|description = Does the fireball projectile lose height due to map gravity?<br />
}}<br />
<br />
===EmgCannon===<br />
A line-of-sight weapon. Visually drawn as a billboarded sprite very similar to that of the [[#Cannon]], however not as customisable, or a 3D model. The name is another [[OTAism]].<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Flame===<br />
A line-of-sight weapon intended for use as a flamethrower or similar. Visually drawn as a stream of textured particles, the colour of which can be controlled very precisely using the {{taglink|colorMap}} tag (see [[CColorMap]]).<br />
<br />
====Flame Visuals====<br />
See also {{taglink|colorMap}}.<br />
<br />
{{tag<br />
|name = sizeGrowth<br />
|type = float<br />
|default = 0.5<br />
|description = How much the draw radius of the flame projectile increases each frame.<br />
}}<br />
<br />
{{tag<br />
|name = flameGFXTime<br />
|type = float<br />
|default = 1.2<br />
|description = Makes the flamethrower projectile stay alive as a visual-only effect (i.e. does not deal any damage) after it has reached maximum {{taglink|range}}. It is a percentage multiplier, e.g. <code>1.2</code> makes the projectile stay alive until it reaches 20% beyond {{taglink|range}}.<br />
}}<br />
<br />
===LaserCannon===<br />
A particularly versatile line-of-sight weapon. Visually drawn like a [http://en.wikipedia.org/wiki/Star_Wars Star Wars] Blaster-style laser weapon, or a 3D model.<br />
<br />
====LaserCannon Visuals====<br />
<br />
{{tag<br />
|name = duration<br />
|type = float<br />
|default = 0.05<br />
|description = Multiplied against {{taglink|weaponVelocity}} to determine the visual length of the beam projectile.<br />
}}<br />
<br />
{{tag<br />
|name = hardStop<br />
|type = bool<br />
|default = false<br />
|description = Does the laser projectile stop dead or fade out?<br />
}}<br />
<br />
{{tag<br />
|name = fallOffRate<br />
|type = float<br />
|default = 0.5<br />
|description = Rate at which the beam fades out after it goes past its maximum {{taglink|range}} if {{taglink|hardStop|false}}. A value of <code>0.0</code> is never fade out, <code>1.0</code> is finish fading out exactly at maximum {{taglink|range}}.<br />
}}<br />
<br />
{{tag<br />
|name = lodDistance<br />
|type = int<br />
|default = 1000<br />
|description = Minimum camera distance at which the default LaserCannon projectile is simplified to a single rectangle.<br />
}}<br />
<br />
{{tag<br />
|name = thickness<br />
|type = float<br />
|default = 2.0<br />
|description = The thickness (width) of the LaserCannon projectile. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = coreThickness<br />
|type = float<br />
|default = 2.0<br />
|description = The thickness (width) of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = rgbColor2<br />
|type = float<br />
|default = {1.0, 1.0, 1.0}<br />
|description = The colour of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
===LightningCannon===<br />
An instant-hit weapon similar to the [[#BeamLaser]], but which does all its damage at once. Visually drawn like [http://en.wikipedia.org/wiki/Star_Wars Star Wars] 'Force Lightning' or [http://en.wikipedia.org/wiki/Command_%26_Conquer:_Red_Alert CnC: Red Alert] [http://en.wikipedia.org/wiki/Tesla_coil Tesla Coil] weapons, the effect is not very customisable.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Melee===<br />
A weapon that always damages the target, no ifs or buts; unsurprisingly intended for use as a close quarters [http://en.wikipedia.org/wiki/Melee#Use_in_gaming 'melee'] weapon. It does not fire a projectile and does not care about the line of fire.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===MissileLauncher===<br />
A versatile weapon which can optionally track targets and accelerate from a low initial velocity. It can also use {{taglink|trajectoryHeight}} to have the shot arc similar to a ballistic projectile. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.<br />
<br />
{{tag<br />
|name = startVelocity<br />
|type = float<br />
|default = 0.0<br />
|description = The initial velocity of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = weaponAcceleration<br />
|type = float<br />
|default = 0.0<br />
|description = The initial acceleration of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Note that if it is <code>0.0</code> the weapon can never increase from its {{taglink|startVelocity}} and will not reach its maximum {{taglink|weaponVelocity}}. Since 99.0 <code>acceleration</code> is a synonym.<br />
}}<br />
<br />
{{tag<br />
|name = tracks<br />
|type = bool<br />
|default = false<br />
|description = Can the weapon projectile track a moving target? Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].}}<br />
<br />
{{tag<br />
|name = turnRate<br />
|type = float<br />
|default = 0.0<br />
|description = The rate (in [[Elmo#Angular|cau]]) at which {{taglink|tracks|true}} weapons turn towards their target. This is relative to a projectile's current velocity; a weapon with a higher velocity will need a higher value in order to be able to hit targets that turn suddenly.}}<br />
<br />
{{tag<br />
|name = flightTime<br />
|type = float<br />
|default = 0.0<br />
|description = The time in seconds before a missile projectile's fuel runs out; it ceases to obey {{taglink|tracks}}, loses velocity and falls to the ground. Also for [[#StarburstLauncher]]. Large values may cause over/undershoot problems.<br />
}}<br />
<br />
{{tag<br />
|name = fixedLauncher<br />
|type = bool<br />
|default = false<br />
|description = Makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Weapons may not correctly obey [[#Collision & Avoidance|avoidance settings]] when using this tag.<br />
}}<br />
<br />
{{tag<br />
|name = wobble<br />
|type = float<br />
|default = 0.0<br />
|description = Adds a random vector to the direction of travel every 16 frames, multiplied by the value of the tag. The effect is reduced as the firing unit gains experience. As this missiles direction is changed, wobbling swarm of missiles will diverge.<br />
}}<br />
<br />
{{tag<br />
|name = dance<br />
|type = float<br />
|default = 0.0<br />
|description = Adds a random vector to the position of a missile projectile every 8 frames, multiplied by the value of the tag. As the projectile is not rotated, a dancing swarm of missiles will remain relatively coherent.<br />
}}<br />
<br />
{{tag<br />
|name = trajectoryHeight<br />
|type = float<br />
|default = 0.0<br />
|description = Determines the height of the arc the missile will reach as it moves towards its target. A value of <code>0.0</code> will result in a flat trajectory, <code>1.0</code> will launch at 45&deg;. Can be any value >= <code>0.0</code>; extreme values may require the {{taglink|tracks}} tag to be able to hit a target.<br />
}}<br />
<br />
====MissileLauncher Visuals====<br />
A note about the missile exhaust flare: the size of the flare is determined by the model radius. The emit position of the flare is at (0,0,-radius) so the model may need careful adjustment to get the flare looking right.<br />
<br />
{{tag<br />
|name = smokeTrail<br />
|type = bool<br />
|default = false<br />
|description = Does the missile projectile emit a smoke trail as it travels? Also for [[#StarburstLauncher]].<br />
}}<br />
<br />
===Rifle===<br />
An instant hit weapon which does all its damage at once. Visually represented by a hardcoded tracer, firing and hitting effects. Rarely used.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Shield (WeaponType)===<br />
As the name suggests, not a weapon but a defensive shield. Can absorb or deflect ({{taglink|repulsor|true}}) projectiles. Individual weapons can be set to be intercepted or not by the shield using a [http://en.wikipedia.org/wiki/Mask_(computing) bitmask] (see [[Shield Interception Tag Use]]). Visually represented as a translucent sphere, with control over colour and texture; by default the shield is invisible ({{taglink|visible|false}}).<br />
<br />
See the [[#shield]] sub-table section for other tags specific to this type.<br />
<br />
===StarburstLauncher===<br />
Fires a projectile that rises vertically for {{taglink|weaponTimer}} seconds, then turns towards its target. It can optionally track targets and accelerate from a low initial velocity. Before spring 92.0 was the only weapon that can be {{taglink|targetable}} and act as an {{taglink|interceptor}}. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.<br />
<br />
{{tag<br />
|name = weaponTimer<br />
|type = float<br />
|default = 0.0<br />
|description = The time in seconds during which the missile ascends vertically before turning towards its target.<br />
}}<br />
<br />
===TorpedoLauncher===<br />
Fires a projectile that will behave ballistically out of water and like a missile in water. Usually used with {{taglink|waterWeapon|true}} so they can fire underwater and target underwater units. An aircraft carrying a [[#TorpedoLauncher]] is a special case, the weapon turns into an [[#AircraftBomb]] projectile that will spawn a torpedo projectile on impact with water. Visually represented by a pointed black cuboid, usually the default object is replaced by a 3D model. <br />
<br />
{{tag<br />
|name = subMissile<br />
|type = bool<br />
|default = false<br />
|description = Can the torpedo leave the water and target units and positions on land?<br />
}}<br />
<br />
===NoWeapon===<br />
Not actually a '''WeaponType''', but an individual weapon requested by Spring to 'fill in the gaps' if a unit claims to have a weapon which isn't actually defined. There needs to be only one of these weapons and it is created by setting {{taglink|weaponName|"NOWEAPON"}} rather than by the {{taglink|weaponType}} tag.<br />
<br />
==Sub Tables==<br />
<br />
===damage===<br />
The damage subtable lists how many hit points the weapon depletes against each armor class (See [[Armordefs.lua]]). It is a key-value map of armor class names and damage values. The special <code>default</code> entry is as the name suggests the default damage applied to any unit which does not belong to a listed armor class, or to shields.<br />
<br />
For example a weapon which deals 100 damage by default but only 50 to units in the 'tank' armor class:<br />
<br />
<code><pre>damage = {<br />
default = 100,<br />
tank = 50,<br />
}</pre></code><br />
<br />
===shield===<br />
The preferred way to create a shield or repulser is to use the shield subtable rather than the old shield tags. <br />
<br />
The following tags are repulser specific:<br />
<br />
{{tag<br />
|name = repulser<br />
|type = bool<br />
|default = false<br />
|description = Does the shield [http://dictionary.reference.com/browse/repulse?s=t repulse] (deflect) projectiles or absorb them? Btw its [http://springrts.com/mantis/view.php?id=4206 not repulsOr, but repulsEr]!}}<br />
<br />
{{tag<br />
|name = force<br />
|type = float<br />
|default = 0.0<br />
|description = The force applied by the repulser to the weapon - higher values will deflect weapons away at higher velocities.}}<br />
<br />
{{tag<br />
|name = maxSpeed<br />
|type = float<br />
|default = 0.0<br />
|description = The maximum speed the repulser will impart to deflected projectiles.}}<br />
<br />
{{tag<br />
|name = visibleRepulse<br />
|type = bool<br />
|default = false<br />
|description = Is the (hard-coded) repulse effect rendered or not?}}<br />
<br />
The following tags are general behaviour for all shields:<br />
<br />
{{tag<br />
|name = interceptType<br />
|type = int<br />
|default = 0<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this shield can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptedByShieldType}} will be intercepted by this shield (See [[Shield Interception Tag Use]]).}}<br />
<br />
{{tag<br />
|name = armorType<br />
|type = string<br />
|default = ""<br />
|description = Specifies the armorclass of the shield; you can input either an [[Armordefs.lua|armorclass]] name OR a unitdef {{xtaglink|Gamedev:UnitDefs|name}} to share that unit's armorclass.}}<br />
<br />
{{tag<br />
|name = smart<br />
|type = bool<br />
|default = false<br />
|description = Determines whether or not projectiles fired by allied units can pass through the shield (<code>true</code>) or are intercepted as enemy weapons are (<code>false</code>).}}<br />
<br />
{{tag<br />
|name = exterior<br />
|type = bool<br />
|default = false<br />
|description = Determines whether or not projectiles fired within the shield's radius can pass through the shield (<code>true</code>) or are intercepted (<code>false</code>).}}<br />
<br />
{{tag<br />
|name = energyUse<br />
|type = float<br />
|default = 0.0<br />
|description = The amount of the energy resource consumed by the shield to absorb or repulse weapons, continually drained by a repulser as long as the projectile is in range.}}<br />
<br />
{{tag<br />
|name = radius<br />
|type = float<br />
|default = 0.0<br />
|description = The radius of the circular area the shield covers.}}<br />
<br />
{{tag<br />
|name = power<br />
|type = float<br />
|default = 0.0<br />
|description = Essentially the maximum allowed hit-points of the shield - reduced by the <code>damage</code> of a weapon upon impact.}}<br />
<br />
{{tag<br />
|name = startingPower<br />
|type = float<br />
|default = 0.0<br />
|description = How many hit-points the shield starts with - otherwise the shield must regenerate from <code>0</code> until it reaches maximum {{taglink|power}}.}}<br />
<br />
{{tag<br />
|name = powerRegen<br />
|type = float<br />
|default = 0.0<br />
|description = How many hit-points the shield regenerates each second.}}<br />
<br />
{{tag<br />
|name = powerRegenEnergy<br />
|type = float<br />
|default = 0.0<br />
|description = How much energy resource is consumed to regenerate each hit-point.}}<br />
<br />
{{tag<br />
|name = rechargeDelay<br />
|type = float<br />
|default = 0.0<br />
|description = The delay in seconds before a shield begins to regenerate after it is hit.}}<br />
<br />
The following tags control the visual aspects of the shield:<br />
<br />
{{tag<br />
|name = visible<br />
|type = bool<br />
|default = false<br />
|description = Is the shield visible or not?}}<br />
<br />
{{tag<br />
|name = visibleHitFrames<br />
|type = int<br />
|default = 0<br />
|description = The number of frames a shield becomes visible for when hit.}}<br />
<br />
{{tag<br />
|name = badColor<br />
|type = float[3]<br />
|default = {1.0, 0.5, 0.5} (Red)<br />
|description = The RGB colour the shield transitions to as its hit-points are reduced towards <code>0</code>.}}<br />
<br />
{{tag<br />
|name = goodColor<br />
|type = float[3]<br />
|default = {0.5, 0.5, 1.0} (Blue)<br />
|description = The RGB colour the shield transitions to as its hit-points are regenerated towards its maximum {{taglink|power}}.}}<br />
<br />
{{tag<br />
|name = alpha<br />
|type = float<br />
|default = 0.2<br />
|description = The alpha transparency of the shield whilst it is visible.}}<br />
<br />
===customParams===<br />
The <code>customParams</code> subtable of a WeaponDef allows the game designer to give their weapons custom attributes, which can then be accessed via lua gadgets and widgets. It is a map (key-value pair indexed table) of strings. When accessing these attributes in lua the strings can be turned back into numbers, bools or even tables. This gives great control to game designers to essentially implement their own behaviour tags.<br />
<br />
There are no additional tags specific to this subtable<br />
<br />
==Examples==<br />
Some games may have most WeaponDefs integrated into their [[Gamedev:UnitDefs#Examples|UnitDefs]].<br />
<br />
S44 and MC:L implement an [http://en.wikipedia.org/wiki/Object-oriented_programming OOP] paradigm with [http://en.wikipedia.org/wiki/Inheritance_(computer_science) inheritance].<br />
<br />
<br />
{{ExampleRepoLinks<br />
|path = weapons/<br />
|entity = WeaponDefs<br />
}}<br />
<br />
[[Category: Game Dev]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Gamedev:WeaponDefs&diff=8805Gamedev:WeaponDefs2015-11-19T20:35:20Z<p>Anarchid: /* Collision & Avoidance */ collisionSize hatepost intensifies</p>
<hr />
<div>[[Gamedev:Main|Development]] < [[Gamedev:Main]] < {{FULLPAGENAME}}<br />
<br />
==Location==<br />
WeaponDef files are .lua files stored in the <code>Weapons/</code> directory of a Spring Game. Alternatively they can be integrated into [[Gamedev:UnitDefs|UnitDefs]].<br />
<br />
==Purpose==<br />
WeaponDef files have one purpose; to define the properties of weapons. They are the main description file for what attributes your weapon should have and how it should behave. Since version 100.0, Spring will record a warning whenever it finds an unknown tag.<br />
<br />
==Source==<br />
The engine source code which loads the tags from these files is viewable here:<br />
<br />
* {{sourcelink|file=rts/Sim/Weapons/WeaponDef.cpp}}<br />
<br />
==Data Types==<br />
{{DataTypes}}<br />
<br />
==Details==<br />
There follows a comprehensive (certain deprecated tags are not present) list of the tags available, their data type, default value and a brief description of what they do. Bear in mind that the source code linked above is the ultimate reference when dealing with these tags. <br />
<br />
In lua tables keys (i.e. the tags) should be lower case, here they are represented in camelCase for readability. In your files you may use the <code>lowerkeys</code> function on your final table to ensure the keys are properly cased.<br />
<br />
It is usual to name the returned WeaponDef table the internal <code>weaponName</code> desired for the weapon.<br />
<br />
===Common===<br />
The following tags are common to all or at least a majority of '''WeaponTypes''', depending on the tag.<br />
<br />
====General====<br />
{{tag<br />
|name = weaponType<br />
|type = string<br />
|default = "Cannon"<br />
|description = Spring has 14 '''WeaponTypes''' which provide game developers with basic behaviours which they can customise to an extent with the '''WeaponDef''' tags. Some tags are specific to certain '''WeaponTypes''' and not implemented for others, [https://docs.google.com/spreadsheet/ccc?key=0Am5BbZxm93S9dEZXc1Q4dXR4TFRYTFM4NlR4OFJFdWc#gid=0 this two-way table] indicates which tags work for which types.}} The possible values are:<br />
* [[#AircraftBomb|AircraftBomb]]<br />
* [[#BeamLaser|BeamLaser]]<br />
* [[#Cannon|Cannon]]<br />
* [[#DGun|Dgun]]<br />
* [[#EmgCannon|EmgCannon]]<br />
* [[#Flame|Flame]]<br />
* [[#LaserCannon|LaserCannon]]<br />
* [[#LightningCannon|LightningCanon]]<br />
* [[#Melee|Melee]]<br />
* [[#MissileLauncher|MissileLauncher]]<br />
* [[#Rifle|Rifle]]<br />
* [[#Shield (WeaponType)|Shield]]<br />
* [[#StarburstLauncher|StarburstLauncher]]<br />
* [[#TorpedoLauncher|TorpedoLauncher]]<br />
<br />
{{tag<br />
|name = name<br />
|type = string<br />
|default = "Weapon"<br />
|description = The descriptive name of the weapon as listed in FPS mode.}}<br />
<br />
{{tag<br />
|name = turret<br />
|type = bool<br />
|default = false<br />
|description = Does the unit aim within an arc (up-to and including full 360° turret traverse) or always aim along the owner's heading?}}<br />
<br />
{{tag<br />
|name = noSelfDamage<br />
|type = bool<br />
|default = false<br />
|description = Can the weapon's explosion damage the unit which fires it? Useful for preventing bombers with high-yield weapons destroying themselves.}}<br />
<br />
{{tag<br />
|name = impactOnly<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon only deal damage through direct hits and not 'splash' damage through {{taglink|areaOfEffect}}?}}<br />
<br />
{{tag<br />
|name = noExplode<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon explode on impact with a target or continue through? Note that these weapons will do damage every single frame they are inside the [[Gamedev:CollisionVolumes|collision volume]] of an object, underground or under water, massively multiplying their damage.}}<br />
<br />
{{tag<br />
|name = burnblow<br />
|type = bool<br />
|default = false<br />
|special = lua: selfExplode<br />
|description = Does the weapon explode when it reaches its maximum range or continue on its path? The name is an [[OTAism]].}}<br />
<br />
{{tag<br />
|name = range<br />
|type = float<br />
|default = 10.0<br />
|description = The maximum range in [[elmo]]s that the weapon can fire at.}}<br />
<br />
{{tag<br />
|name = weaponVelocity<br />
|type = float<br />
|default = 0.0<br />
|description = The velocity in [[elmo]]s per second of the weapon projectile. Since 99.0 <code>maxVelocity</code> is a synonym.}}<br />
<br />
{{tag<br />
|name = reloadTime<br />
|type = float<br />
|default = 1.0<br />
|description = The time in seconds between shots fired.}}<br />
<br />
{{tag<br />
|name = metalPerShot<br />
|type = float<br />
|default = 0.0<br />
|description = 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 {{taglink|stockpile}} weapon will cost to build.}}<br />
<br />
{{tag<br />
|name = energyPerShot<br />
|type = float<br />
|default = 0.0<br />
|description = Energy used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a {{taglink|stockpile}} weapon will cost to build.}}<br />
<br />
{{tag<br />
|name = myGravity<br />
|type = float<br />
|default = 0.0<br />
|description = Overrides the map gravity for ballistic weapons. The default of <code>0.0</code> disables the tag in favour of map gravity.}}<br />
<br />
{{tag<br />
|name = fireStarter<br />
|type = float<br />
|default = 0.0<br />
|description = The percentage chance (<code>0.0</code> to <code>100.0</code>) of the weapon setting fire to static map features on impact.}}<br />
<br />
{{tag<br />
|name = cameraShake<br />
|type = float<br />
|default = damage (0.0 for paralyzers)<br />
|description = Passed to the [[LuaCallinReturn#Game_Events:|ShockFront() callin]] as the first argument. Intended as a means to make the camera shake if in range of detonation.}}<br />
<br />
{{tag<br />
|name = stockpile<br />
|type = bool<br />
|default = false<br />
|description = Does each round of the weapon have to be built and stockpiled by the player? Will only correctly function for the first of each stockpiled weapons a unit has.}}<br />
<br />
{{tag<br />
|name = stockpileTime<br />
|type = float<br />
|default = reloadTime<br />
|description = The time in seconds taken to stockpile one round of the weapon.}}<br />
<br />
{{tag<br />
|name = interceptedByShieldType<br />
|type = int<br />
|default = Depends on {{taglink|weaponType}}<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of shields that can intercept this weapon. Each digit of binary that is set to one means that a shield with the corresponding digit in its {{taglink|interceptType}} will intercept this weapon. A value of <code>0</code> means that no shields will intercept the weapon. The defaults are as follows:<br />
* <code>0</code> - [[#DGun]]<br />
* <code>1</code> - [[#Cannon]] and [[#EmgCannon]]<br />
* <code>2</code> - [[#LaserCannon]] and [[#BeamLaser]]<br />
* <code>4</code> - [[#MissileLauncher]] and [[#StarburstLauncher]]<br />
* <code>8</code> - [[#AircraftBomb]]<br />
* <code>16</code> - [[#Flame]]<br />
* <code>32</code> - [[#TorpedoLauncher]]<br />
* <code>64</code> - [[#LightningCannon]]<br />
* <code>128</code> - [[#Rifle]]<br />
* <code>256</code> - [[#Melee]]<br />
(See [[Shield Interception Tag Use]]).}}<br />
<br />
====Collision & Avoidance====<br />
<br />
{{tag<br />
|name = avoidGround<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if terrain blocks the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidFriendly<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if a friendly unit is in the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidFeature<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if a static map feature is in the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidNeutral<br />
|type = bool<br />
|default = false<br />
|description = Should the weapon avoid firing if a neutral unit is in the line of fire?}}<br />
<br />
{{tag<br />
|name = collideEnemy<br />
|type = bool<br />
|default = true<br />
|special = lua: noEnemyCollide<br />
|description = Does the weapon projectile collide with enemy units or pass through?}}<br />
<br />
{{tag<br />
|name = collideFriendly<br />
|type = bool<br />
|default = true<br />
|special = lua: noFriendlyCollide<br />
|description = Does the weapon projectile collide with friendly units or pass through?}}<br />
<br />
{{tag<br />
|name = collideFeature<br />
|type = bool<br />
|default = true<br />
|special = lua: noFeatureCollide<br />
|description = Does the weapon projectile collide with static map features or pass through?}}<br />
<br />
{{tag<br />
|name = collideNeutral<br />
|type = bool<br />
|default = true<br />
|special = lua: noNeutralCollide<br />
|description = Does the weapon projectile collide with neutral units or pass through?}}<br />
<br />
{{tag<br />
|name = collideGround<br />
|type = bool<br />
|default = true<br />
|special = lua: noGroundCollide<br />
|description = Does the weapon projectile collide with terrain or pass through?}}<br />
<br />
{{tag<br />
|name = collisionSize<br />
|type = float<br />
|default = 0.05 (0.5 for [[#Flame]] and [[#LaserCannon]], 10.0 for [[#Dgun]])<br />
|description = Modifies size of EMG and Flame projectiles, and physical size '''only''' for hitscan interceptor weapons (e.g. antinuke lasers). [[https://github.com/spring/spring/blob/3034e5f5a8f5b9fb4624a97f7a85cb5c90457725/rts/Sim/Projectiles/WeaponProjectiles/WeaponProjectile.cpp#L250 1]][[https://github.com/spring/spring/blob/master/rts/Sim/Misc/CollisionHandler.cpp#L33 2]]}}<br />
<br />
====Targeting & Accuracy====<br />
{{tag<br />
|name = commandFire<br />
|type = bool<br />
|default = false<br />
|description = Determines if the weapon will automatically fire on enemy units in range or only when manually ordered to attack.}}<br />
<br />
{{tag<br />
|name = canAttackGround<br />
|type = bool<br />
|default = true<br />
|description = Determines if the weapon can be force-fired on ground positions or only fire on targeted units.}}<br />
<br />
{{tag<br />
|name = waterWeapon<br />
|type = bool<br />
|default = false<br />
|description = Determines if the weapon can pass through water and target underwater units.}}<br />
<br />
{{tag<br />
|name = fireSubmersed<br />
|type = bool<br />
|default = waterWeapon<br />
|description = Determines if the weapon can fire whilst underwater.}}<br />
<br />
{{tag<br />
|name = targetBorder<br />
|type = float<br />
|default = 0.0 (1.0 for [[#Melee]])<br />
|description = Controls whether the weapon aims for the centre or the edge of its target's [[Gamedev:CollisionVolumes|collision volume]]. Clamped between <code>-1.0</code> - target the far border, and <code>1.0</code> - target the near border.}}<br />
<br />
{{tag<br />
|name = cylinderTargeting<br />
|type = float<br />
|default = 0.0 (1.0 for [[#Melee]])<br />
|description = Controls whether the weapon range is calculated in a sphere or a cylinder. The height of the cylinder is determined by the value of this tag multiplied by the {{taglink|range}}. Clamped between <code>0.0</code> and <code>128.0</code>.}}<br />
<br />
{{tag<br />
|name = tolerance<br />
|type = float<br />
|default = 3000.0 (+/- ~18 degrees)<br />
|description = The amount (in [[Gamedev:UnitsOfMeasurement#Angular|cau]]) to which the weapon's "real" aim can be off while the weapon will still be able to fire accurately at the target. For {{taglink|turret|false}} or {{taglink|fixedLauncher|true}} weapons this determines in what arc the unit will fire.}}<br />
<br />
{{tag<br />
|name = fireTolerance<br />
|type = float<br />
|default = 32768.0 (+/- 180 degrees)<br />
|special = {{new|99.0}}<br />
|description = Final check to prevent weapons from shooting sideways. If a weapon is about to fire but the difference between its old aim and requested aim is greater than this angle (in [[Gamedev:UnitsOfMeasurement#Angular|cau]]) then it will not fire.}}<br />
<br />
{{tag<br />
|name = allowNonBlockingAim<br />
|type = bool<br />
|default = false<br />
|special = {{new|99.0}}<br />
|description = When enabled it makes [[Animation-LuaCallins#Weapons|AimWeapon()]] script calls non-blocking (still the {{taglink|fireTolerance}} tag might prevent the weapon firing). This is very useful for fast units that need to re-target often.}}<br />
<br />
{{tag<br />
|name = targetMoveError<br />
|type = float<br />
|default = 0.0<br />
|description = 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.}}<br />
<br />
{{tag<br />
|name = leadLimit<br />
|type = float<br />
|default = -1.0<br />
|description = Limits the maximum distance a unit will lead a target. The default of <code>-1</code> allows an infinite distance.}}<br />
<br />
{{tag<br />
|name = leadBonus<br />
|type = float<br />
|default = 0.0<br />
|description = Controls how experience boosts the weapon's target leading. Is multiplied with the unit's experience and added to the {{taglink|leadLimit}}.}}<br />
<br />
{{tag<br />
|name = predictBoost<br />
|type = float<br />
|default = 0.0 (0.5 for {{taglink|burnblow|true}} weapons)<br />
|description = Controls how well the weapon predicts unit speeds. Works in a similar way to {{taglink|targetMoveError}} except that it is 1-dimensional. This tag spreads the shots in a line based on the direction of the target whereas {{taglink|targetMoveError}} spreads the shots all around based on the movement.}}<br />
<br />
{{tag<br />
|name = heightMod<br />
|type = float<br />
|default = 0.2 (0.8 for [[#Cannon]], 1.0 for [[#BeamLaser]] and [[#LightningCannon]])<br />
|description = Changes the spherical weapon range into an ellipsoid. Values above <code>1.0</code> mean the weapon cannot target as high as it can far, values below <code>1.0</code> mean it can target higher than it can far. For example <code>0.5</code> would allow the weapon to target twice as high as far.}}<br />
<br />
{{tag<br />
|name = proximityPriority<br />
|type = float<br />
|default = 1.0<br />
|description = Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets.}}<br />
<br />
{{tag<br />
|name = accuracy<br />
|type = float<br />
|default = 0.0<br />
|description = How accurate the weapon is. Lower values are more accurate. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high value will probably still hit. If a target is very far away, even a very low value will likely cause the weapon to miss.}}<br />
<br />
{{tag<br />
|name = movingAccuracy<br />
|type = float<br />
|default = accuracy<br />
|description = A weapon's {{taglink|accuracy}} whilst the owning unit is moving.}}<br />
<br />
{{tag<br />
|name = sprayAngle<br />
|type = float<br />
|default = 0.0<br />
|description = How wide the the angle of a burst from a [[#Bursts|burst weapon]] can be. Very similar to {{taglink|accuracy}}, except that this tag affects each projectile in a burst, whilst the former does not.}}<br />
<br />
{{tag<br />
|name = ownerExpAccWeight<br />
|type = float<br />
|default = 0.0 (See description)<br />
|description = A multiplier to {{taglink|accuracy}} and {{taglink|sprayAngle}} that reduces inaccuracy as a units experience increases. Defaults are as follows:<br />
* <code>0.9</code> - [[#Cannon]], [[#Rifle]]<br />
* <code>0.7</code> - [[#LaserCannon]], [[#BeamLaser]], [[#StarburstLauncher]]<br />
* <code>0.5</code> - [[#MissileLauncher]], [[#LightningCannon]], [[#EmgCannon]], [[#DGun]]<br />
* <code>0.2</code> - [[#Flame]]<br />
}}<br />
<br />
{{tag<br />
|name = targetable<br />
|type = int<br />
|default = 0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapon that can intercept this weapon. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptor}} tag will intercept this weapon. Instant-hitting weapons such as [[#BeamLaser]], [[#LightningCannon]] and [[#Rifle]] cannot be targeted.<br />
}}<br />
<br />
{{tag<br />
|name = interceptor<br />
|type = int<br />
|default = 0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this weapon can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|targetable}} tag will be intercepted by this weapon.<br />
}}<br />
<br />
{{tag<br />
|name = interceptSolo<br />
|type = bool<br />
|default = true<br />
|special = {{new|92.0}} <br />
|description = If <code>true</code> no other interceptors may target the same projectile.<br />
}}<br />
<br />
{{tag<br />
|name = coverage<br />
|type = float<br />
|default = 0.0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = The radius in [[elmo]]s within which an {{taglink|interceptor}} weapon will fire on {{taglink|targetable}} weapons.<br />
}}<br />
<br />
====Bouncing====<br />
<br />
{{tag<br />
|name = waterBounce<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon bounce on water impacts?}}<br />
<br />
{{tag<br />
|name = groundBounce<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon bounce on ground impacts?}}<br />
<br />
{{tag<br />
|name = bounceSlip<br />
|type = float<br />
|default = 1.0<br />
|description = The decimal-percentage amount of horizontal velocity a projectile keeps when it bounces.}}<br />
<br />
{{tag<br />
|name = bounceRebound<br />
|type = float<br />
|default = 1.0<br />
|description = The decimal-percentage amount of vertical velocity a projectile keeps when it bounces.}}<br />
<br />
{{tag<br />
|name = numBounce<br />
|type = int<br />
|default = -1<br />
|description = The number of times the weapon will bounce on impact before exploding. The default value of <code>-1</code> allows infinite bounces (at least until velocity reaches 0).}}<br />
<br />
====Area Of Effect, Impulse & Cratering====<br />
<br />
{{tag<br />
|name = areaOfEffect<br />
|type = float<br />
|default = 8.0 * 0.5<br />
|special = lua: damageAreaOfEffect<br />
|description = The ''diameter'' in [[elmo]]s in which the weapons explosion will cause damage.}}<br />
<br />
{{tag<br />
|name = craterAreaOfEffect<br />
|type = float<br />
|default = areaOfEffect * 0.5<br />
|description = The ''radius'' in [[elmo]]s in which the weapons explosion will cause terrain cratering. Behaviour changed slightly in 98.0 as previously craters were 1.5x {{taglink|craterAreaOfEffect}} whilst decals were 1.0x, they are now both the same size.}}<br />
<br />
{{tag<br />
|name = edgeEffectiveness<br />
|type = float<br />
|default = 0.0<br />
|description = Determines what percent of a weapon's maximum damage value will be applied to units within the weapon's {{taglink|areaOfEffect}}. Falls off from the epicentre according to the formula <code>damageApplied = damage * [(areaOfEffect - distToUnit) / (areaOfEffect - (distToUnit * edgeEffectiveness))]</code>, a graph of the function for various values is available [[Media:EdgeEffectiveness.png|here]].}}<br />
<br />
{{tag<br />
|name = explosionSpeed<br />
|type = float<br />
|default = See description<br />
|description = The speed at which the weapon's explosion propagates from the epicentre. The default is calculated by this complex formula: <code>defExpSpeed = {8.0 + [max(30.0, default_damage / 20.0) * 2.5]} / {9.0f + [sqrt(max(30.0, default_damage / 20.0f)) * 0.7]} * 0.5</code>.}}<br />
<br />
{{tag<br />
|name = impulseFactor<br />
|type = float<br />
|default = 1.0<br />
|description = A multiplier to the impulse given to units within the explosion {{taglink|areaOfEffect}}, which is otherwise equal to the damage dealt after {{taglink|edgeEffectiveness}} is taken into account. For [[#Melee]] weapons this is instead multiplied by the owning unit's mass (See [[Gamedev:UnitDefs#Tag:mass|Gamedev:UnitDefs]]).}}<br />
<br />
{{tag<br />
|name = impulseBoost<br />
|type = float<br />
|default = 0.0<br />
|description = A constant amount added to the weapon's impulse, regardless of distance from the epicentre or the damage potential of the explosion, prior to the application of {{taglink|impulseFactor}}}}<br />
<br />
{{tag<br />
|name = craterMult<br />
|type = float<br />
|default = impulseFactor<br />
|description = A multiplier to depth of terrain crater the weapon's explosion will create, which is otherwise based on the damage potential.}}<br />
<br />
{{tag<br />
|name = craterBoost<br />
|type = float<br />
|default = 0.0<br />
|description = A constant amount, added to the weapon's cratering depth before the application of {{taglink|craterMult}}.}}<br />
<br />
====Bursts====<br />
<br />
{{tag<br />
|name = burst<br />
|type = int<br />
|default = 1<br />
|special = lua: salvoSize<br />
|description = How many shots to fire per burst.<br />
}}<br />
<br />
{{tag<br />
|name = burstRate<br />
|type = float<br />
|default = 0.1<br />
|special = lua: salvoDelay<br />
|description = The time in seconds between shots in a burst. Note that {{taglink|reloadTime}} starts to count down from the ''first'' round fired, not the last so if <code>reloadTime < burst * burstRate</code> the weapon will fire continuously.<br />
}}<br />
<br />
{{tag<br />
|name = projectiles<br />
|type = int<br />
|default = 1<br />
|description = How many projectiles released per shot (shotgun style). e.g. a weapon with {{taglink|burst|5}}, {{taglink|burstRate|0.5}} and {{taglink|projectiles|2}} will shoot 5 lots of 2 for 10 projectiles total, with gaps of 0.5 seconds, before waiting for {{taglink|reloadTime}}. Best used in conjunction with {{taglink|sprayAngle}} or changing the firing piece using [[Animation-LuaCallins#Weapons|ShotX]] as otherwise they'll all be clumped in one shot.<br />
}}<br />
<br />
====Paralyzing====<br />
{{tag<br />
|name = paralyzer<br />
|type = bool<br />
|default = false<br />
|description = Is the weapon a paralyzer? If <code>true</code> the weapon only stuns enemy units and does not cause damage in the form of lost hit-points.<br />
}}<br />
<br />
{{tag<br />
|name = paralyzeTime<br />
|type = int<br />
|default = 10<br />
|special = lua: damages.paralyzeDamageTime<br />
|description = Determines the maximum length of time in seconds that the target will be paralyzed. The timer is restarted every time the target is hit by the weapon. Cannot be less than <code>0</code>.<br />
}}<br />
<br />
====Dynamic Damage====<br />
The following set of tags allow for a weapon's damage potential to vary with the distance to its target.<br />
<br />
{{tag<br />
|name = dynDamageExp<br />
|type = float<br />
|default = 0.0<br />
|description = Exponent of the range-dependent damage formula, the default of <code>0.0</code> disables dynamic damage, <code>1.0</code> means linear scaling, <code>2.0</code> quadratic and so on.<br />
}}<br />
<br />
{{tag<br />
|name = dynDamageMin<br />
|type = float<br />
|default = 0.0<br />
|description = The minimum floor value that range-dependent damage can drop to.<br />
}}<br />
<br />
{{tag<br />
|name = dynDamageRange<br />
|type = float<br />
|default = 0.0<br />
|description = If set to non-zero values the weapon will use this value in the range-dependant damage formula instead of the actual {{taglink|range}}. <br />
}}<br />
<br />
{{tag<br />
|name = dynDamageInverted<br />
|type = bool<br />
|default = false<br />
|description = If <code>true</code> the damage curve is inverted i.e. the weapon does more damage at greater ranges as opposed to less.<br />
}}<br />
<br />
====Sounds====<br />
{{tag<br />
|name = soundTrigger<br />
|type = bool<br />
|default = false (true for [[#Melee]], [[#Rifle]] and non-beamBurst [[#BeamLaser]])<br />
|description = Does the weapon play {{taglink|soundStart}} only once for each salvo (<code>true</code>) or for every round in a burst (<code>false</code>)?}}<br />
<br />
{{tag<br />
|name = soundStart<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon fires.}}<br />
<br />
{{tag<br />
|name = soundHitDry<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with solid ground. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}<br />
<br />
{{tag<br />
|name = soundHitWet<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with water. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}<br />
<br />
====Visuals====<br />
<br />
{{tag<br />
|name = cegTag<br />
|type = string<br />
|default = ""<br />
|description = The name, without prefixes, of a [[CEG]] to be emitted by the projectile each frame.<br />
}}<br />
<br />
{{tag<br />
|name = intensity<br />
|type = float<br />
|default = 0.9 (0.2 for [[#Cannon]])<br />
|description = Alpha transparency for non-3D model projectiles. Lower values are more opaque, but <code>0.0</code> will cause the projectile to disappear entirely.<br />
}}<br />
<br />
{{tag<br />
|name = model<br />
|type = string<br />
|default = ""<br />
|description = The filename of a 3D model to use when rendering the projectile. Note that only the root piece of a projectile model is rendered. Currently only for [[#Cannon]], [[#LaserCannon]], [[#MissileLauncher]], [[#StarburstLauncher]] and [[#TorpedoLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = explosionScar<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon's explosion leave a scar decal on the ground? For all types except [[#Melee]] and [[#Rifle]].<br />
}}<br />
<br />
{{tag<br />
|name = alwaysVisible<br />
|type = bool<br />
|default = false<br />
|description = If <code>true</code> the weapon is always rendered regardless of whether or not it is in LOS range of a player's units.<br />
}}<br />
<br />
{{tag<br />
|name = rgbColor<br />
|type = float[3]<br />
|default = {1.0, 0.0, 0.0} (See Description)<br />
|description = The primary colour for sprite rendering weapons. Additional defaults are as follows:<br />
* [[#Cannon]] - <code>{1.0, 0.5, 0.0}</code><br />
* [[#EmgCannon]] - <code>{0.9, 0.9, 0.2}</code><br />
}}<br />
<br />
{{tag<br />
|name = explosionGenerator<br />
|type = string<br />
|default = ""<br />
|description = The name of a [[CEG]], with <code>custom:</code> prefix, to spawn as the weapon's explosion. Does not currently work for [[#Melee]] and [[#Rifle]].<br />
}}<br />
<br />
{{tag<br />
|name = bounceExplosionGenerator<br />
|type = string<br />
|default = ""<br />
|description = For weapons which can use {{taglink|groundBounce|true}}, the name of a [[CEG]], with <code>custom:</code> prefix, to spawn when weapon the bounces.<br />
}}<br />
<br />
{{tag<br />
|name = texture1<br />
|type = string<br />
|default = ""<br />
|description = The projectile texture for [[#AircraftBomb]], [[#Cannon]], [[#EmgCannon]], [[#Flame]]; beam texture for [[#LaserCannon]], [[#BeamLaser]], [[#LightningCannon]]; flare texture for [[#MissileLauncher]], [[#StarburstLauncher]] and dome texture for the [[#Shield]].<br />
}}<br />
<br />
{{tag<br />
|name = texture2<br />
|type = string<br />
|default = ""<br />
|description = The end-of-beam texture for [[#LaserCannon]], [[#BeamLaser]] and {{taglink|smoketrail}} texture for [[#MissileLauncher]], [[#StarburstLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = texture3<br />
|type = string<br />
|default = ""<br />
|description = Flare texture for [[#BeamLaser]], or muzzle texture if {{taglink|largeBeamLaser|true}}. Also used as the flame texture for [[#StarburstLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = texture4<br />
|type = string<br />
|default = ""<br />
|description = Flare texture for [[#BeamLaser]] with {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
===AircraftBomb===<br />
Drops a ballistic projectile at the same movement vector as the unit itself. Intended only for aircraft. Visually drawn as a billboarded sprite as used by the [[#Cannon]], but more commonly used with a 3D model.<br />
<br />
There are no tags specific to this '''WeaponType'''<br />
<br />
====AircraftBomb Visuals====<br />
<br />
When not using a {{taglink|model}}, the AircraftBomb is the same as [[#Cannon Visuals]].<br />
<br />
===BeamLaser===<br />
An instant-hit weapon which spawns a beam and does a portion of its total damage each frame. Cannot be [[Animation-LuaCallouts#Effects|script emitted]] if it has a {{taglink|beamTime}} longer than one frame. Visually drawn as a [http://en.wikipedia.org/wiki/Star_Trek Star Trek] Phaser-style laser weapon. The {{taglink|largeBeamLaser}} tag allows changing the visual effect of the laser, such as using a tileable, scrolling texture without changing the behaviour.<br />
<br />
{{tag<br />
|name = minIntensity<br />
|type = float<br />
|default = 0.0<br />
|description = The minimum percentage the weapon's damage can fall-off to over its range. Setting to <code>1.0</code> will disable fall off entirely. Unrelated to the visual-only {{taglink|intensity}} tag.<br />
}}<br />
<br />
{{tag<br />
|name = beamTime<br />
|type = float<br />
|default = 1.0<br />
|description = How long in seconds to fire the laser before waiting for {{taglink|reloadTime}} to start. Damage is distributed over the duration of the {{taglink|beamTime}}, and the weapon will aim to hit the target when the beam is in the middle of its {{taglink|beamTime}} (i.e. using prediction).<br />
}}<br />
<br />
{{tag<br />
|name = beamBurst<br />
|type = bool<br />
|default = false<br />
|description = Makes the laser fire a burst of beams that are all aimed towards the target (instead of aimed with the piece). A [[#BeamLaser]] can do its full damage with every shot if {{taglink|beamBurst}} is enabled. Disables {{taglink|beamTime}} in favour of the [[#Bursts|burst tags]].<br />
}}<br />
<br />
{{tag<br />
|name = sweepFire<br />
|type = bool<br />
|default = false<br />
|description = Makes the laser continue firing while it aims for a new target, 'sweeping' across the terrain. Reimplemented in 95.0, still has no script interaction so use with care. Respects {{taglink|reloadTime}} constraint but not much else.<br />
}}<br />
<br />
====BeamLaser Visuals====<br />
<br />
See also {{taglink|thickness}} and {{taglink|coreThickness}}.<br />
<br />
{{tag<br />
|name = beamTTL<br />
|type = int<br />
|default = 0<br />
|description = The time in frames for which the laser beam remains visible.<br />
}}<br />
<br />
{{tag<br />
|name = beamDecay<br />
|type = float<br />
|default = 1.0<br />
|description = How fast the beam fades out. Each frame the {{taglink|intensity}} is multiplied by this value.<br />
}}<br />
<br />
{{tag<br />
|name = laserFlareSize<br />
|type = float<br />
|default = 15.0<br />
|description = Determines the size of the firing flare.<br />
}}<br />
<br />
{{tag<br />
|name = largeBeamLaser<br />
|type = bool<br />
|default = false<br />
|description = Changes the visual effect allowing tiling and scrolling of the texture and a pulsating firing flare.<br />
}}<br />
<br />
{{tag<br />
|name = tileLength<br />
|type = float<br />
|default = 200.0<br />
|description = Defines the length before the texture used is repeated (tiled). Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
{{tag<br />
|name = scrollSpeed<br />
|type = float<br />
|default = 5.0<br />
|description = Controls how fast the texture scrolls. Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
{{tag<br />
|name = pulseSpeed<br />
|type = float<br />
|default = 1.0<br />
|description = Controls how fast the pulsating effect at the start of the beam is. Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
===Cannon===<br />
The default '''WeaponType'''. Fires a ballistic projectile, for the best result (without under/overshooting) the {{taglink|weaponVelocity}} should be set so as to give an elevation of 45° when firing at the maximum {{taglink|range}}. Substituting the angle into the [http://en.wikipedia.org/wiki/Trajectory#Range_and_height trajectory equation] and rearranging, we get: <br />
<code><pre>weaponVelocity = √(range * g)</pre></code> <br />
where <code>g</code> is the map gravity, usually around <code>120</code> for most Spring maps (You can use the {{taglink|myGravity}} tag if you want to be exact). Visually drawn as a billboarded sprite or 3D model. <br />
<br />
{{tag<br />
|name = highTrajectory<br />
|type = int<br />
|default = 2<br />
|description = Can this weapon be fired in a high trajectory (>45° angle). Can be <code>0</code> - low trajectory only, <code>1</code> - high trajectory only or <code>2</code> - enables a high/low toggle button on the unit.<br />
}}<br />
<br />
{{tag<br />
|name = heightBoostFactor<br />
|type = float<br />
|default = -1.0<br />
|description = Controls the boost given to {{taglink|range}} by high terrain. Values > <code>1.0</code> result in increased range, <code>0.0</code> means the cannon has fixed range regardless of height difference to target. Any value < <code>0.0</code> (i.e. the default value) result in an automatically calculated value based on {{taglink|range}} and theoretical maximum range.<br />
}}<br />
<br />
====Cannon Visuals====<br />
<br />
{{tag<br />
|name = size<br />
|type = float<br />
|default = 2.0 + min(default_damage * 0.0025, {{taglink|areaOfEffect}} * 0.1)<br />
|description = The drawing radius of the billboarded sprite. Also for [[#AircraftBomb Visuals]], [[#EmgCannon Visuals]] (default: <code>3.0</code>) and [[#Flame Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = colorMap<br />
|type = string<br />
|default = ""<br />
|description = A set of RGB colours to transition between over the projectile's lifetime. Can be given as a string of RGB digits or an image filename (See [[CColorMap]]). Also for [[#Flame Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = sizeDecay<br />
|type = float<br />
|default = 0.0<br />
|description = How quickly each particle of the Cannon shot decays in size.<br />
}}<br />
<br />
{{tag<br />
|name = alphaDecay<br />
|type = float<br />
|default = 1.0<br />
|description = How quickly each particle of the Cannon shot fades out.<br />
}}<br />
<br />
{{tag<br />
|name = separation<br />
|type = float<br />
|default = 0.0<br />
|description = The distance between each particle of the Cannon shot.<br />
}}<br />
<br />
{{tag<br />
|name = noGap<br />
|type = bool<br />
|default = true<br />
|description = Switch between the distance between particles being proportional to the size of the two particles (<code>true</code>) or proportional to the size of the first particle (<code>false</code>). <br />
}}<br />
<br />
{{tag<br />
|name = stages<br />
|type = int<br />
|default = 5<br />
|description = The number of particles in each Cannon shot.<br />
}}<br />
<br />
===DGun===<br />
Fires a line-of-sight or ballistic projectile (selected via the {{taglink|gravityAffected}} tag). Visually represented by a fireball effect that cannot be customised, however it can be replaced by a 3D model. The name and visual effect are [[OTAism]]s.<br />
<br />
{{tag<br />
|name = gravityAffected<br />
|type = bool<br />
|default = false<br />
|description = Does the fireball projectile lose height due to map gravity?<br />
}}<br />
<br />
===EmgCannon===<br />
A line-of-sight weapon. Visually drawn as a billboarded sprite very similar to that of the [[#Cannon]], however not as customisable, or a 3D model. The name is another [[OTAism]].<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Flame===<br />
A line-of-sight weapon intended for use as a flamethrower or similar. Visually drawn as a stream of textured particles, the colour of which can be controlled very precisely using the {{taglink|colorMap}} tag (see [[CColorMap]]).<br />
<br />
====Flame Visuals====<br />
See also {{taglink|colorMap}}.<br />
<br />
{{tag<br />
|name = sizeGrowth<br />
|type = float<br />
|default = 0.5<br />
|description = How much the draw radius of the flame projectile increases each frame.<br />
}}<br />
<br />
{{tag<br />
|name = flameGFXTime<br />
|type = float<br />
|default = 1.2<br />
|description = Makes the flamethrower projectile stay alive as a visual-only effect (i.e. does not deal any damage) after it has reached maximum {{taglink|range}}. It is a percentage multiplier, e.g. <code>1.2</code> makes the projectile stay alive until it reaches 20% beyond {{taglink|range}}.<br />
}}<br />
<br />
===LaserCannon===<br />
A particularly versatile line-of-sight weapon. Visually drawn like a [http://en.wikipedia.org/wiki/Star_Wars Star Wars] Blaster-style laser weapon, or a 3D model.<br />
<br />
====LaserCannon Visuals====<br />
<br />
{{tag<br />
|name = duration<br />
|type = float<br />
|default = 0.05<br />
|description = Multiplied against {{taglink|weaponVelocity}} to determine the visual length of the beam projectile.<br />
}}<br />
<br />
{{tag<br />
|name = hardStop<br />
|type = bool<br />
|default = false<br />
|description = Does the laser projectile stop dead or fade out?<br />
}}<br />
<br />
{{tag<br />
|name = fallOffRate<br />
|type = float<br />
|default = 0.5<br />
|description = Rate at which the beam fades out after it goes past its maximum {{taglink|range}} if {{taglink|hardStop|false}}. A value of <code>0.0</code> is never fade out, <code>1.0</code> is finish fading out exactly at maximum {{taglink|range}}.<br />
}}<br />
<br />
{{tag<br />
|name = lodDistance<br />
|type = int<br />
|default = 1000<br />
|description = Minimum camera distance at which the default LaserCannon projectile is simplified to a single rectangle.<br />
}}<br />
<br />
{{tag<br />
|name = thickness<br />
|type = float<br />
|default = 2.0<br />
|description = The thickness (width) of the LaserCannon projectile. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = coreThickness<br />
|type = float<br />
|default = 2.0<br />
|description = The thickness (width) of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = rgbColor2<br />
|type = float<br />
|default = {1.0, 1.0, 1.0}<br />
|description = The colour of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
===LightningCannon===<br />
An instant-hit weapon similar to the [[#BeamLaser]], but which does all its damage at once. Visually drawn like [http://en.wikipedia.org/wiki/Star_Wars Star Wars] 'Force Lightning' or [http://en.wikipedia.org/wiki/Command_%26_Conquer:_Red_Alert CnC: Red Alert] [http://en.wikipedia.org/wiki/Tesla_coil Tesla Coil] weapons, the effect is not very customisable.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Melee===<br />
A weapon that always damages the target, no ifs or buts; unsurprisingly intended for use as a close quarters [http://en.wikipedia.org/wiki/Melee#Use_in_gaming 'melee'] weapon. It does not fire a projectile and does not care about the line of fire.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===MissileLauncher===<br />
A versatile weapon which can optionally track targets and accelerate from a low initial velocity. It can also use {{taglink|trajectoryHeight}} to have the shot arc similar to a ballistic projectile. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.<br />
<br />
{{tag<br />
|name = startVelocity<br />
|type = float<br />
|default = 0.0<br />
|description = The initial velocity of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = weaponAcceleration<br />
|type = float<br />
|default = 0.0<br />
|description = The initial acceleration of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Note that if it is <code>0.0</code> the weapon can never increase from its {{taglink|startVelocity}} and will not reach its maximum {{taglink|weaponVelocity}}. Since 99.0 <code>acceleration</code> is a synonym.<br />
}}<br />
<br />
{{tag<br />
|name = tracks<br />
|type = bool<br />
|default = false<br />
|description = Can the weapon projectile track a moving target? Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].}}<br />
<br />
{{tag<br />
|name = turnRate<br />
|type = float<br />
|default = 0.0<br />
|description = The rate (in [[Elmo#Angular|cau]]) at which {{taglink|tracks|true}} weapons turn towards their target. This is relative to a projectile's current velocity; a weapon with a higher velocity will need a higher value in order to be able to hit targets that turn suddenly.}}<br />
<br />
{{tag<br />
|name = flightTime<br />
|type = float<br />
|default = 0.0<br />
|description = The time in seconds before a missile projectile's fuel runs out; it ceases to obey {{taglink|tracks}}, loses velocity and falls to the ground. Also for [[#StarburstLauncher]]. Large values may cause over/undershoot problems.<br />
}}<br />
<br />
{{tag<br />
|name = fixedLauncher<br />
|type = bool<br />
|default = false<br />
|description = Makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Weapons may not correctly obey [[#Collision & Avoidance|avoidance settings]] when using this tag.<br />
}}<br />
<br />
{{tag<br />
|name = wobble<br />
|type = float<br />
|default = 0.0<br />
|description = Adds a random vector to the direction of travel every 16 frames, multiplied by the value of the tag. The effect is reduced as the firing unit gains experience. As this missiles direction is changed, wobbling swarm of missiles will diverge.<br />
}}<br />
<br />
{{tag<br />
|name = dance<br />
|type = float<br />
|default = 0.0<br />
|description = Adds a random vector to the position of a missile projectile every 8 frames, multiplied by the value of the tag. As the projectile is not rotated, a dancing swarm of missiles will remain relatively coherent.<br />
}}<br />
<br />
{{tag<br />
|name = trajectoryHeight<br />
|type = float<br />
|default = 0.0<br />
|description = Determines the height of the arc the missile will reach as it moves towards its target. A value of <code>0.0</code> will result in a flat trajectory, <code>1.0</code> will launch at 45&deg;. Can be any value >= <code>0.0</code>; extreme values may require the {{taglink|tracks}} tag to be able to hit a target.<br />
}}<br />
<br />
====MissileLauncher Visuals====<br />
A note about the missile exhaust flare: the size of the flare is determined by the model radius. The emit position of the flare is at (0,0,-radius) so the model may need careful adjustment to get the flare looking right.<br />
<br />
{{tag<br />
|name = smokeTrail<br />
|type = bool<br />
|default = false<br />
|description = Does the missile projectile emit a smoke trail as it travels? Also for [[#StarburstLauncher]].<br />
}}<br />
<br />
===Rifle===<br />
An instant hit weapon which does all its damage at once. Visually represented by a hardcoded tracer, firing and hitting effects. Rarely used.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Shield (WeaponType)===<br />
As the name suggests, not a weapon but a defensive shield. Can absorb or deflect ({{taglink|repulsor|true}}) projectiles. Individual weapons can be set to be intercepted or not by the shield using a [http://en.wikipedia.org/wiki/Mask_(computing) bitmask] (see [[Shield Interception Tag Use]]). Visually represented as a translucent sphere, with control over colour and texture; by default the shield is invisible ({{taglink|visible|false}}).<br />
<br />
See the [[#shield]] sub-table section for other tags specific to this type.<br />
<br />
===StarburstLauncher===<br />
Fires a projectile that rises vertically for {{taglink|weaponTimer}} seconds, then turns towards its target. It can optionally track targets and accelerate from a low initial velocity. Before spring 92.0 was the only weapon that can be {{taglink|targetable}} and act as an {{taglink|interceptor}}. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.<br />
<br />
{{tag<br />
|name = weaponTimer<br />
|type = float<br />
|default = 0.0<br />
|description = The time in seconds during which the missile ascends vertically before turning towards its target.<br />
}}<br />
<br />
===TorpedoLauncher===<br />
Fires a projectile that will behave ballistically out of water and like a missile in water. Usually used with {{taglink|waterWeapon|true}} so they can fire underwater and target underwater units. An aircraft carrying a [[#TorpedoLauncher]] is a special case, the weapon turns into an [[#AircraftBomb]] projectile that will spawn a torpedo projectile on impact with water. Visually represented by a pointed black cuboid, usually the default object is replaced by a 3D model. <br />
<br />
{{tag<br />
|name = subMissile<br />
|type = bool<br />
|default = false<br />
|description = Can the torpedo leave the water and target units and positions on land?<br />
}}<br />
<br />
===NoWeapon===<br />
Not actually a '''WeaponType''', but an individual weapon requested by Spring to 'fill in the gaps' if a unit claims to have a weapon which isn't actually defined. There needs to be only one of these weapons and it is created by setting {{taglink|weaponName|"NOWEAPON"}} rather than by the {{taglink|weaponType}} tag.<br />
<br />
==Sub Tables==<br />
<br />
===damage===<br />
The damage subtable lists how many hit points the weapon depletes against each armor class (See [[Armordefs.lua]]). It is a key-value map of armor class names and damage values. The special <code>default</code> entry is as the name suggests the default damage applied to any unit which does not belong to a listed armor class, or to shields.<br />
<br />
For example a weapon which deals 100 damage by default but only 50 to units in the 'tank' armor class:<br />
<br />
<code><pre>damage = {<br />
default = 100,<br />
tank = 50,<br />
}</pre></code><br />
<br />
===shield===<br />
The preferred way to create a shield or repulser is to use the shield subtable rather than the old shield tags. <br />
<br />
The following tags are repulser specific:<br />
<br />
{{tag<br />
|name = repulser<br />
|type = bool<br />
|default = false<br />
|description = Does the shield [http://dictionary.reference.com/browse/repulse?s=t repulse] (deflect) projectiles or absorb them? Btw its [http://springrts.com/mantis/view.php?id=4206 not repulsOr, but repulsEr]!}}<br />
<br />
{{tag<br />
|name = force<br />
|type = float<br />
|default = 0.0<br />
|description = The force applied by the repulser to the weapon - higher values will deflect weapons away at higher velocities.}}<br />
<br />
{{tag<br />
|name = maxSpeed<br />
|type = float<br />
|default = 0.0<br />
|description = The maximum speed the repulser will impart to deflected projectiles.}}<br />
<br />
{{tag<br />
|name = visibleRepulse<br />
|type = bool<br />
|default = false<br />
|description = Is the (hard-coded) repulse effect rendered or not?}}<br />
<br />
The following tags are general behaviour for all shields:<br />
<br />
{{tag<br />
|name = interceptType<br />
|type = int<br />
|default = 0<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this shield can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptedByShieldType}} will be intercepted by this shield (See [[Shield Interception Tag Use]]).}}<br />
<br />
{{tag<br />
|name = armorType<br />
|type = string<br />
|default = ""<br />
|description = Specifies the armorclass of the shield; you can input either an [[Armordefs.lua|armorclass]] name OR a unitdef {{xtaglink|Gamedev:UnitDefs|name}} to share that unit's armorclass.}}<br />
<br />
{{tag<br />
|name = smart<br />
|type = bool<br />
|default = false<br />
|description = Determines whether or not projectiles fired by allied units can pass through the shield (<code>true</code>) or are intercepted as enemy weapons are (<code>false</code>).}}<br />
<br />
{{tag<br />
|name = exterior<br />
|type = bool<br />
|default = false<br />
|description = Determines whether or not projectiles fired within the shield's radius can pass through the shield (<code>true</code>) or are intercepted (<code>false</code>).}}<br />
<br />
{{tag<br />
|name = energyUse<br />
|type = float<br />
|default = 0.0<br />
|description = The amount of the energy resource consumed by the shield to absorb or repulse weapons, continually drained by a repulser as long as the projectile is in range.}}<br />
<br />
{{tag<br />
|name = radius<br />
|type = float<br />
|default = 0.0<br />
|description = The radius of the circular area the shield covers.}}<br />
<br />
{{tag<br />
|name = power<br />
|type = float<br />
|default = 0.0<br />
|description = Essentially the maximum allowed hit-points of the shield - reduced by the <code>damage</code> of a weapon upon impact.}}<br />
<br />
{{tag<br />
|name = startingPower<br />
|type = float<br />
|default = 0.0<br />
|description = How many hit-points the shield starts with - otherwise the shield must regenerate from <code>0</code> until it reaches maximum {{taglink|power}}.}}<br />
<br />
{{tag<br />
|name = powerRegen<br />
|type = float<br />
|default = 0.0<br />
|description = How many hit-points the shield regenerates each second.}}<br />
<br />
{{tag<br />
|name = powerRegenEnergy<br />
|type = float<br />
|default = 0.0<br />
|description = How much energy resource is consumed to regenerate each hit-point.}}<br />
<br />
{{tag<br />
|name = rechargeDelay<br />
|type = float<br />
|default = 0.0<br />
|description = The delay in seconds before a shield begins to regenerate after it is hit.}}<br />
<br />
The following tags control the visual aspects of the shield:<br />
<br />
{{tag<br />
|name = visible<br />
|type = bool<br />
|default = false<br />
|description = Is the shield visible or not?}}<br />
<br />
{{tag<br />
|name = visibleHitFrames<br />
|type = int<br />
|default = 0<br />
|description = The number of frames a shield becomes visible for when hit.}}<br />
<br />
{{tag<br />
|name = badColor<br />
|type = float[3]<br />
|default = {1.0, 0.5, 0.5} (Red)<br />
|description = The RGB colour the shield transitions to as its hit-points are reduced towards <code>0</code>.}}<br />
<br />
{{tag<br />
|name = goodColor<br />
|type = float[3]<br />
|default = {0.5, 0.5, 1.0} (Blue)<br />
|description = The RGB colour the shield transitions to as its hit-points are regenerated towards its maximum {{taglink|power}}.}}<br />
<br />
{{tag<br />
|name = alpha<br />
|type = float<br />
|default = 0.2<br />
|description = The alpha transparency of the shield whilst it is visible.}}<br />
<br />
===customParams===<br />
The <code>customParams</code> subtable of a WeaponDef allows the game designer to give their weapons custom attributes, which can then be accessed via lua gadgets and widgets. It is a map (key-value pair indexed table) of strings. When accessing these attributes in lua the strings can be turned back into numbers, bools or even tables. This gives great control to game designers to essentially implement their own behaviour tags.<br />
<br />
There are no additional tags specific to this subtable<br />
<br />
==Examples==<br />
Some games may have most WeaponDefs integrated into their [[Gamedev:UnitDefs#Examples|UnitDefs]].<br />
<br />
S44 and MC:L implement an [http://en.wikipedia.org/wiki/Object-oriented_programming OOP] paradigm with [http://en.wikipedia.org/wiki/Inheritance_(computer_science) inheritance].<br />
<br />
<br />
{{ExampleRepoLinks<br />
|path = weapons/<br />
|entity = WeaponDefs<br />
}}<br />
<br />
[[Category: Game Dev]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Gamedev:WeaponDefs&diff=8804Gamedev:WeaponDefs2015-11-19T20:31:45Z<p>Anarchid: /* Collision & Avoidance */</p>
<hr />
<div>[[Gamedev:Main|Development]] < [[Gamedev:Main]] < {{FULLPAGENAME}}<br />
<br />
==Location==<br />
WeaponDef files are .lua files stored in the <code>Weapons/</code> directory of a Spring Game. Alternatively they can be integrated into [[Gamedev:UnitDefs|UnitDefs]].<br />
<br />
==Purpose==<br />
WeaponDef files have one purpose; to define the properties of weapons. They are the main description file for what attributes your weapon should have and how it should behave. Since version 100.0, Spring will record a warning whenever it finds an unknown tag.<br />
<br />
==Source==<br />
The engine source code which loads the tags from these files is viewable here:<br />
<br />
* {{sourcelink|file=rts/Sim/Weapons/WeaponDef.cpp}}<br />
<br />
==Data Types==<br />
{{DataTypes}}<br />
<br />
==Details==<br />
There follows a comprehensive (certain deprecated tags are not present) list of the tags available, their data type, default value and a brief description of what they do. Bear in mind that the source code linked above is the ultimate reference when dealing with these tags. <br />
<br />
In lua tables keys (i.e. the tags) should be lower case, here they are represented in camelCase for readability. In your files you may use the <code>lowerkeys</code> function on your final table to ensure the keys are properly cased.<br />
<br />
It is usual to name the returned WeaponDef table the internal <code>weaponName</code> desired for the weapon.<br />
<br />
===Common===<br />
The following tags are common to all or at least a majority of '''WeaponTypes''', depending on the tag.<br />
<br />
====General====<br />
{{tag<br />
|name = weaponType<br />
|type = string<br />
|default = "Cannon"<br />
|description = Spring has 14 '''WeaponTypes''' which provide game developers with basic behaviours which they can customise to an extent with the '''WeaponDef''' tags. Some tags are specific to certain '''WeaponTypes''' and not implemented for others, [https://docs.google.com/spreadsheet/ccc?key=0Am5BbZxm93S9dEZXc1Q4dXR4TFRYTFM4NlR4OFJFdWc#gid=0 this two-way table] indicates which tags work for which types.}} The possible values are:<br />
* [[#AircraftBomb|AircraftBomb]]<br />
* [[#BeamLaser|BeamLaser]]<br />
* [[#Cannon|Cannon]]<br />
* [[#DGun|Dgun]]<br />
* [[#EmgCannon|EmgCannon]]<br />
* [[#Flame|Flame]]<br />
* [[#LaserCannon|LaserCannon]]<br />
* [[#LightningCannon|LightningCanon]]<br />
* [[#Melee|Melee]]<br />
* [[#MissileLauncher|MissileLauncher]]<br />
* [[#Rifle|Rifle]]<br />
* [[#Shield (WeaponType)|Shield]]<br />
* [[#StarburstLauncher|StarburstLauncher]]<br />
* [[#TorpedoLauncher|TorpedoLauncher]]<br />
<br />
{{tag<br />
|name = name<br />
|type = string<br />
|default = "Weapon"<br />
|description = The descriptive name of the weapon as listed in FPS mode.}}<br />
<br />
{{tag<br />
|name = turret<br />
|type = bool<br />
|default = false<br />
|description = Does the unit aim within an arc (up-to and including full 360° turret traverse) or always aim along the owner's heading?}}<br />
<br />
{{tag<br />
|name = noSelfDamage<br />
|type = bool<br />
|default = false<br />
|description = Can the weapon's explosion damage the unit which fires it? Useful for preventing bombers with high-yield weapons destroying themselves.}}<br />
<br />
{{tag<br />
|name = impactOnly<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon only deal damage through direct hits and not 'splash' damage through {{taglink|areaOfEffect}}?}}<br />
<br />
{{tag<br />
|name = noExplode<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon explode on impact with a target or continue through? Note that these weapons will do damage every single frame they are inside the [[Gamedev:CollisionVolumes|collision volume]] of an object, underground or under water, massively multiplying their damage.}}<br />
<br />
{{tag<br />
|name = burnblow<br />
|type = bool<br />
|default = false<br />
|special = lua: selfExplode<br />
|description = Does the weapon explode when it reaches its maximum range or continue on its path? The name is an [[OTAism]].}}<br />
<br />
{{tag<br />
|name = range<br />
|type = float<br />
|default = 10.0<br />
|description = The maximum range in [[elmo]]s that the weapon can fire at.}}<br />
<br />
{{tag<br />
|name = weaponVelocity<br />
|type = float<br />
|default = 0.0<br />
|description = The velocity in [[elmo]]s per second of the weapon projectile. Since 99.0 <code>maxVelocity</code> is a synonym.}}<br />
<br />
{{tag<br />
|name = reloadTime<br />
|type = float<br />
|default = 1.0<br />
|description = The time in seconds between shots fired.}}<br />
<br />
{{tag<br />
|name = metalPerShot<br />
|type = float<br />
|default = 0.0<br />
|description = 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 {{taglink|stockpile}} weapon will cost to build.}}<br />
<br />
{{tag<br />
|name = energyPerShot<br />
|type = float<br />
|default = 0.0<br />
|description = Energy used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a {{taglink|stockpile}} weapon will cost to build.}}<br />
<br />
{{tag<br />
|name = myGravity<br />
|type = float<br />
|default = 0.0<br />
|description = Overrides the map gravity for ballistic weapons. The default of <code>0.0</code> disables the tag in favour of map gravity.}}<br />
<br />
{{tag<br />
|name = fireStarter<br />
|type = float<br />
|default = 0.0<br />
|description = The percentage chance (<code>0.0</code> to <code>100.0</code>) of the weapon setting fire to static map features on impact.}}<br />
<br />
{{tag<br />
|name = cameraShake<br />
|type = float<br />
|default = damage (0.0 for paralyzers)<br />
|description = Passed to the [[LuaCallinReturn#Game_Events:|ShockFront() callin]] as the first argument. Intended as a means to make the camera shake if in range of detonation.}}<br />
<br />
{{tag<br />
|name = stockpile<br />
|type = bool<br />
|default = false<br />
|description = Does each round of the weapon have to be built and stockpiled by the player? Will only correctly function for the first of each stockpiled weapons a unit has.}}<br />
<br />
{{tag<br />
|name = stockpileTime<br />
|type = float<br />
|default = reloadTime<br />
|description = The time in seconds taken to stockpile one round of the weapon.}}<br />
<br />
{{tag<br />
|name = interceptedByShieldType<br />
|type = int<br />
|default = Depends on {{taglink|weaponType}}<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of shields that can intercept this weapon. Each digit of binary that is set to one means that a shield with the corresponding digit in its {{taglink|interceptType}} will intercept this weapon. A value of <code>0</code> means that no shields will intercept the weapon. The defaults are as follows:<br />
* <code>0</code> - [[#DGun]]<br />
* <code>1</code> - [[#Cannon]] and [[#EmgCannon]]<br />
* <code>2</code> - [[#LaserCannon]] and [[#BeamLaser]]<br />
* <code>4</code> - [[#MissileLauncher]] and [[#StarburstLauncher]]<br />
* <code>8</code> - [[#AircraftBomb]]<br />
* <code>16</code> - [[#Flame]]<br />
* <code>32</code> - [[#TorpedoLauncher]]<br />
* <code>64</code> - [[#LightningCannon]]<br />
* <code>128</code> - [[#Rifle]]<br />
* <code>256</code> - [[#Melee]]<br />
(See [[Shield Interception Tag Use]]).}}<br />
<br />
====Collision & Avoidance====<br />
<br />
{{tag<br />
|name = avoidGround<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if terrain blocks the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidFriendly<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if a friendly unit is in the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidFeature<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if a static map feature is in the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidNeutral<br />
|type = bool<br />
|default = false<br />
|description = Should the weapon avoid firing if a neutral unit is in the line of fire?}}<br />
<br />
{{tag<br />
|name = collideEnemy<br />
|type = bool<br />
|default = true<br />
|special = lua: noEnemyCollide<br />
|description = Does the weapon projectile collide with enemy units or pass through?}}<br />
<br />
{{tag<br />
|name = collideFriendly<br />
|type = bool<br />
|default = true<br />
|special = lua: noFriendlyCollide<br />
|description = Does the weapon projectile collide with friendly units or pass through?}}<br />
<br />
{{tag<br />
|name = collideFeature<br />
|type = bool<br />
|default = true<br />
|special = lua: noFeatureCollide<br />
|description = Does the weapon projectile collide with static map features or pass through?}}<br />
<br />
{{tag<br />
|name = collideNeutral<br />
|type = bool<br />
|default = true<br />
|special = lua: noNeutralCollide<br />
|description = Does the weapon projectile collide with neutral units or pass through?}}<br />
<br />
{{tag<br />
|name = collideGround<br />
|type = bool<br />
|default = true<br />
|special = lua: noGroundCollide<br />
|description = Does the weapon projectile collide with terrain or pass through?}}<br />
<br />
{{tag<br />
|name = collisionSize<br />
|type = float<br />
|default = 0.05 (0.5 for [[#Flame]] and [[#LaserCannon]], 10.0 for [[#Dgun]])<br />
|description = Modifies size of EMG and Flame projectiles, and physical size '''only''' for [https://github.com/spring/spring/blob/3034e5f5a8f5b9fb4624a97f7a85cb5c90457725/rts/Sim/Projectiles/WeaponProjectiles/WeaponProjectile.cpp#L250 hitscan] interceptor weapons (e.g. antinuke lasers).}}<br />
<br />
====Targeting & Accuracy====<br />
{{tag<br />
|name = commandFire<br />
|type = bool<br />
|default = false<br />
|description = Determines if the weapon will automatically fire on enemy units in range or only when manually ordered to attack.}}<br />
<br />
{{tag<br />
|name = canAttackGround<br />
|type = bool<br />
|default = true<br />
|description = Determines if the weapon can be force-fired on ground positions or only fire on targeted units.}}<br />
<br />
{{tag<br />
|name = waterWeapon<br />
|type = bool<br />
|default = false<br />
|description = Determines if the weapon can pass through water and target underwater units.}}<br />
<br />
{{tag<br />
|name = fireSubmersed<br />
|type = bool<br />
|default = waterWeapon<br />
|description = Determines if the weapon can fire whilst underwater.}}<br />
<br />
{{tag<br />
|name = targetBorder<br />
|type = float<br />
|default = 0.0 (1.0 for [[#Melee]])<br />
|description = Controls whether the weapon aims for the centre or the edge of its target's [[Gamedev:CollisionVolumes|collision volume]]. Clamped between <code>-1.0</code> - target the far border, and <code>1.0</code> - target the near border.}}<br />
<br />
{{tag<br />
|name = cylinderTargeting<br />
|type = float<br />
|default = 0.0 (1.0 for [[#Melee]])<br />
|description = Controls whether the weapon range is calculated in a sphere or a cylinder. The height of the cylinder is determined by the value of this tag multiplied by the {{taglink|range}}. Clamped between <code>0.0</code> and <code>128.0</code>.}}<br />
<br />
{{tag<br />
|name = tolerance<br />
|type = float<br />
|default = 3000.0 (+/- ~18 degrees)<br />
|description = The amount (in [[Gamedev:UnitsOfMeasurement#Angular|cau]]) to which the weapon's "real" aim can be off while the weapon will still be able to fire accurately at the target. For {{taglink|turret|false}} or {{taglink|fixedLauncher|true}} weapons this determines in what arc the unit will fire.}}<br />
<br />
{{tag<br />
|name = fireTolerance<br />
|type = float<br />
|default = 32768.0 (+/- 180 degrees)<br />
|special = {{new|99.0}}<br />
|description = Final check to prevent weapons from shooting sideways. If a weapon is about to fire but the difference between its old aim and requested aim is greater than this angle (in [[Gamedev:UnitsOfMeasurement#Angular|cau]]) then it will not fire.}}<br />
<br />
{{tag<br />
|name = allowNonBlockingAim<br />
|type = bool<br />
|default = false<br />
|special = {{new|99.0}}<br />
|description = When enabled it makes [[Animation-LuaCallins#Weapons|AimWeapon()]] script calls non-blocking (still the {{taglink|fireTolerance}} tag might prevent the weapon firing). This is very useful for fast units that need to re-target often.}}<br />
<br />
{{tag<br />
|name = targetMoveError<br />
|type = float<br />
|default = 0.0<br />
|description = 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.}}<br />
<br />
{{tag<br />
|name = leadLimit<br />
|type = float<br />
|default = -1.0<br />
|description = Limits the maximum distance a unit will lead a target. The default of <code>-1</code> allows an infinite distance.}}<br />
<br />
{{tag<br />
|name = leadBonus<br />
|type = float<br />
|default = 0.0<br />
|description = Controls how experience boosts the weapon's target leading. Is multiplied with the unit's experience and added to the {{taglink|leadLimit}}.}}<br />
<br />
{{tag<br />
|name = predictBoost<br />
|type = float<br />
|default = 0.0 (0.5 for {{taglink|burnblow|true}} weapons)<br />
|description = Controls how well the weapon predicts unit speeds. Works in a similar way to {{taglink|targetMoveError}} except that it is 1-dimensional. This tag spreads the shots in a line based on the direction of the target whereas {{taglink|targetMoveError}} spreads the shots all around based on the movement.}}<br />
<br />
{{tag<br />
|name = heightMod<br />
|type = float<br />
|default = 0.2 (0.8 for [[#Cannon]], 1.0 for [[#BeamLaser]] and [[#LightningCannon]])<br />
|description = Changes the spherical weapon range into an ellipsoid. Values above <code>1.0</code> mean the weapon cannot target as high as it can far, values below <code>1.0</code> mean it can target higher than it can far. For example <code>0.5</code> would allow the weapon to target twice as high as far.}}<br />
<br />
{{tag<br />
|name = proximityPriority<br />
|type = float<br />
|default = 1.0<br />
|description = Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets.}}<br />
<br />
{{tag<br />
|name = accuracy<br />
|type = float<br />
|default = 0.0<br />
|description = How accurate the weapon is. Lower values are more accurate. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high value will probably still hit. If a target is very far away, even a very low value will likely cause the weapon to miss.}}<br />
<br />
{{tag<br />
|name = movingAccuracy<br />
|type = float<br />
|default = accuracy<br />
|description = A weapon's {{taglink|accuracy}} whilst the owning unit is moving.}}<br />
<br />
{{tag<br />
|name = sprayAngle<br />
|type = float<br />
|default = 0.0<br />
|description = How wide the the angle of a burst from a [[#Bursts|burst weapon]] can be. Very similar to {{taglink|accuracy}}, except that this tag affects each projectile in a burst, whilst the former does not.}}<br />
<br />
{{tag<br />
|name = ownerExpAccWeight<br />
|type = float<br />
|default = 0.0 (See description)<br />
|description = A multiplier to {{taglink|accuracy}} and {{taglink|sprayAngle}} that reduces inaccuracy as a units experience increases. Defaults are as follows:<br />
* <code>0.9</code> - [[#Cannon]], [[#Rifle]]<br />
* <code>0.7</code> - [[#LaserCannon]], [[#BeamLaser]], [[#StarburstLauncher]]<br />
* <code>0.5</code> - [[#MissileLauncher]], [[#LightningCannon]], [[#EmgCannon]], [[#DGun]]<br />
* <code>0.2</code> - [[#Flame]]<br />
}}<br />
<br />
{{tag<br />
|name = targetable<br />
|type = int<br />
|default = 0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapon that can intercept this weapon. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptor}} tag will intercept this weapon. Instant-hitting weapons such as [[#BeamLaser]], [[#LightningCannon]] and [[#Rifle]] cannot be targeted.<br />
}}<br />
<br />
{{tag<br />
|name = interceptor<br />
|type = int<br />
|default = 0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this weapon can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|targetable}} tag will be intercepted by this weapon.<br />
}}<br />
<br />
{{tag<br />
|name = interceptSolo<br />
|type = bool<br />
|default = true<br />
|special = {{new|92.0}} <br />
|description = If <code>true</code> no other interceptors may target the same projectile.<br />
}}<br />
<br />
{{tag<br />
|name = coverage<br />
|type = float<br />
|default = 0.0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = The radius in [[elmo]]s within which an {{taglink|interceptor}} weapon will fire on {{taglink|targetable}} weapons.<br />
}}<br />
<br />
====Bouncing====<br />
<br />
{{tag<br />
|name = waterBounce<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon bounce on water impacts?}}<br />
<br />
{{tag<br />
|name = groundBounce<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon bounce on ground impacts?}}<br />
<br />
{{tag<br />
|name = bounceSlip<br />
|type = float<br />
|default = 1.0<br />
|description = The decimal-percentage amount of horizontal velocity a projectile keeps when it bounces.}}<br />
<br />
{{tag<br />
|name = bounceRebound<br />
|type = float<br />
|default = 1.0<br />
|description = The decimal-percentage amount of vertical velocity a projectile keeps when it bounces.}}<br />
<br />
{{tag<br />
|name = numBounce<br />
|type = int<br />
|default = -1<br />
|description = The number of times the weapon will bounce on impact before exploding. The default value of <code>-1</code> allows infinite bounces (at least until velocity reaches 0).}}<br />
<br />
====Area Of Effect, Impulse & Cratering====<br />
<br />
{{tag<br />
|name = areaOfEffect<br />
|type = float<br />
|default = 8.0 * 0.5<br />
|special = lua: damageAreaOfEffect<br />
|description = The ''diameter'' in [[elmo]]s in which the weapons explosion will cause damage.}}<br />
<br />
{{tag<br />
|name = craterAreaOfEffect<br />
|type = float<br />
|default = areaOfEffect * 0.5<br />
|description = The ''radius'' in [[elmo]]s in which the weapons explosion will cause terrain cratering. Behaviour changed slightly in 98.0 as previously craters were 1.5x {{taglink|craterAreaOfEffect}} whilst decals were 1.0x, they are now both the same size.}}<br />
<br />
{{tag<br />
|name = edgeEffectiveness<br />
|type = float<br />
|default = 0.0<br />
|description = Determines what percent of a weapon's maximum damage value will be applied to units within the weapon's {{taglink|areaOfEffect}}. Falls off from the epicentre according to the formula <code>damageApplied = damage * [(areaOfEffect - distToUnit) / (areaOfEffect - (distToUnit * edgeEffectiveness))]</code>, a graph of the function for various values is available [[Media:EdgeEffectiveness.png|here]].}}<br />
<br />
{{tag<br />
|name = explosionSpeed<br />
|type = float<br />
|default = See description<br />
|description = The speed at which the weapon's explosion propagates from the epicentre. The default is calculated by this complex formula: <code>defExpSpeed = {8.0 + [max(30.0, default_damage / 20.0) * 2.5]} / {9.0f + [sqrt(max(30.0, default_damage / 20.0f)) * 0.7]} * 0.5</code>.}}<br />
<br />
{{tag<br />
|name = impulseFactor<br />
|type = float<br />
|default = 1.0<br />
|description = A multiplier to the impulse given to units within the explosion {{taglink|areaOfEffect}}, which is otherwise equal to the damage dealt after {{taglink|edgeEffectiveness}} is taken into account. For [[#Melee]] weapons this is instead multiplied by the owning unit's mass (See [[Gamedev:UnitDefs#Tag:mass|Gamedev:UnitDefs]]).}}<br />
<br />
{{tag<br />
|name = impulseBoost<br />
|type = float<br />
|default = 0.0<br />
|description = A constant amount added to the weapon's impulse, regardless of distance from the epicentre or the damage potential of the explosion, prior to the application of {{taglink|impulseFactor}}}}<br />
<br />
{{tag<br />
|name = craterMult<br />
|type = float<br />
|default = impulseFactor<br />
|description = A multiplier to depth of terrain crater the weapon's explosion will create, which is otherwise based on the damage potential.}}<br />
<br />
{{tag<br />
|name = craterBoost<br />
|type = float<br />
|default = 0.0<br />
|description = A constant amount, added to the weapon's cratering depth before the application of {{taglink|craterMult}}.}}<br />
<br />
====Bursts====<br />
<br />
{{tag<br />
|name = burst<br />
|type = int<br />
|default = 1<br />
|special = lua: salvoSize<br />
|description = How many shots to fire per burst.<br />
}}<br />
<br />
{{tag<br />
|name = burstRate<br />
|type = float<br />
|default = 0.1<br />
|special = lua: salvoDelay<br />
|description = The time in seconds between shots in a burst. Note that {{taglink|reloadTime}} starts to count down from the ''first'' round fired, not the last so if <code>reloadTime < burst * burstRate</code> the weapon will fire continuously.<br />
}}<br />
<br />
{{tag<br />
|name = projectiles<br />
|type = int<br />
|default = 1<br />
|description = How many projectiles released per shot (shotgun style). e.g. a weapon with {{taglink|burst|5}}, {{taglink|burstRate|0.5}} and {{taglink|projectiles|2}} will shoot 5 lots of 2 for 10 projectiles total, with gaps of 0.5 seconds, before waiting for {{taglink|reloadTime}}. Best used in conjunction with {{taglink|sprayAngle}} or changing the firing piece using [[Animation-LuaCallins#Weapons|ShotX]] as otherwise they'll all be clumped in one shot.<br />
}}<br />
<br />
====Paralyzing====<br />
{{tag<br />
|name = paralyzer<br />
|type = bool<br />
|default = false<br />
|description = Is the weapon a paralyzer? If <code>true</code> the weapon only stuns enemy units and does not cause damage in the form of lost hit-points.<br />
}}<br />
<br />
{{tag<br />
|name = paralyzeTime<br />
|type = int<br />
|default = 10<br />
|special = lua: damages.paralyzeDamageTime<br />
|description = Determines the maximum length of time in seconds that the target will be paralyzed. The timer is restarted every time the target is hit by the weapon. Cannot be less than <code>0</code>.<br />
}}<br />
<br />
====Dynamic Damage====<br />
The following set of tags allow for a weapon's damage potential to vary with the distance to its target.<br />
<br />
{{tag<br />
|name = dynDamageExp<br />
|type = float<br />
|default = 0.0<br />
|description = Exponent of the range-dependent damage formula, the default of <code>0.0</code> disables dynamic damage, <code>1.0</code> means linear scaling, <code>2.0</code> quadratic and so on.<br />
}}<br />
<br />
{{tag<br />
|name = dynDamageMin<br />
|type = float<br />
|default = 0.0<br />
|description = The minimum floor value that range-dependent damage can drop to.<br />
}}<br />
<br />
{{tag<br />
|name = dynDamageRange<br />
|type = float<br />
|default = 0.0<br />
|description = If set to non-zero values the weapon will use this value in the range-dependant damage formula instead of the actual {{taglink|range}}. <br />
}}<br />
<br />
{{tag<br />
|name = dynDamageInverted<br />
|type = bool<br />
|default = false<br />
|description = If <code>true</code> the damage curve is inverted i.e. the weapon does more damage at greater ranges as opposed to less.<br />
}}<br />
<br />
====Sounds====<br />
{{tag<br />
|name = soundTrigger<br />
|type = bool<br />
|default = false (true for [[#Melee]], [[#Rifle]] and non-beamBurst [[#BeamLaser]])<br />
|description = Does the weapon play {{taglink|soundStart}} only once for each salvo (<code>true</code>) or for every round in a burst (<code>false</code>)?}}<br />
<br />
{{tag<br />
|name = soundStart<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon fires.}}<br />
<br />
{{tag<br />
|name = soundHitDry<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with solid ground. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}<br />
<br />
{{tag<br />
|name = soundHitWet<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with water. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}<br />
<br />
====Visuals====<br />
<br />
{{tag<br />
|name = cegTag<br />
|type = string<br />
|default = ""<br />
|description = The name, without prefixes, of a [[CEG]] to be emitted by the projectile each frame.<br />
}}<br />
<br />
{{tag<br />
|name = intensity<br />
|type = float<br />
|default = 0.9 (0.2 for [[#Cannon]])<br />
|description = Alpha transparency for non-3D model projectiles. Lower values are more opaque, but <code>0.0</code> will cause the projectile to disappear entirely.<br />
}}<br />
<br />
{{tag<br />
|name = model<br />
|type = string<br />
|default = ""<br />
|description = The filename of a 3D model to use when rendering the projectile. Note that only the root piece of a projectile model is rendered. Currently only for [[#Cannon]], [[#LaserCannon]], [[#MissileLauncher]], [[#StarburstLauncher]] and [[#TorpedoLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = explosionScar<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon's explosion leave a scar decal on the ground? For all types except [[#Melee]] and [[#Rifle]].<br />
}}<br />
<br />
{{tag<br />
|name = alwaysVisible<br />
|type = bool<br />
|default = false<br />
|description = If <code>true</code> the weapon is always rendered regardless of whether or not it is in LOS range of a player's units.<br />
}}<br />
<br />
{{tag<br />
|name = rgbColor<br />
|type = float[3]<br />
|default = {1.0, 0.0, 0.0} (See Description)<br />
|description = The primary colour for sprite rendering weapons. Additional defaults are as follows:<br />
* [[#Cannon]] - <code>{1.0, 0.5, 0.0}</code><br />
* [[#EmgCannon]] - <code>{0.9, 0.9, 0.2}</code><br />
}}<br />
<br />
{{tag<br />
|name = explosionGenerator<br />
|type = string<br />
|default = ""<br />
|description = The name of a [[CEG]], with <code>custom:</code> prefix, to spawn as the weapon's explosion. Does not currently work for [[#Melee]] and [[#Rifle]].<br />
}}<br />
<br />
{{tag<br />
|name = bounceExplosionGenerator<br />
|type = string<br />
|default = ""<br />
|description = For weapons which can use {{taglink|groundBounce|true}}, the name of a [[CEG]], with <code>custom:</code> prefix, to spawn when weapon the bounces.<br />
}}<br />
<br />
{{tag<br />
|name = texture1<br />
|type = string<br />
|default = ""<br />
|description = The projectile texture for [[#AircraftBomb]], [[#Cannon]], [[#EmgCannon]], [[#Flame]]; beam texture for [[#LaserCannon]], [[#BeamLaser]], [[#LightningCannon]]; flare texture for [[#MissileLauncher]], [[#StarburstLauncher]] and dome texture for the [[#Shield]].<br />
}}<br />
<br />
{{tag<br />
|name = texture2<br />
|type = string<br />
|default = ""<br />
|description = The end-of-beam texture for [[#LaserCannon]], [[#BeamLaser]] and {{taglink|smoketrail}} texture for [[#MissileLauncher]], [[#StarburstLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = texture3<br />
|type = string<br />
|default = ""<br />
|description = Flare texture for [[#BeamLaser]], or muzzle texture if {{taglink|largeBeamLaser|true}}. Also used as the flame texture for [[#StarburstLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = texture4<br />
|type = string<br />
|default = ""<br />
|description = Flare texture for [[#BeamLaser]] with {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
===AircraftBomb===<br />
Drops a ballistic projectile at the same movement vector as the unit itself. Intended only for aircraft. Visually drawn as a billboarded sprite as used by the [[#Cannon]], but more commonly used with a 3D model.<br />
<br />
There are no tags specific to this '''WeaponType'''<br />
<br />
====AircraftBomb Visuals====<br />
<br />
When not using a {{taglink|model}}, the AircraftBomb is the same as [[#Cannon Visuals]].<br />
<br />
===BeamLaser===<br />
An instant-hit weapon which spawns a beam and does a portion of its total damage each frame. Cannot be [[Animation-LuaCallouts#Effects|script emitted]] if it has a {{taglink|beamTime}} longer than one frame. Visually drawn as a [http://en.wikipedia.org/wiki/Star_Trek Star Trek] Phaser-style laser weapon. The {{taglink|largeBeamLaser}} tag allows changing the visual effect of the laser, such as using a tileable, scrolling texture without changing the behaviour.<br />
<br />
{{tag<br />
|name = minIntensity<br />
|type = float<br />
|default = 0.0<br />
|description = The minimum percentage the weapon's damage can fall-off to over its range. Setting to <code>1.0</code> will disable fall off entirely. Unrelated to the visual-only {{taglink|intensity}} tag.<br />
}}<br />
<br />
{{tag<br />
|name = beamTime<br />
|type = float<br />
|default = 1.0<br />
|description = How long in seconds to fire the laser before waiting for {{taglink|reloadTime}} to start. Damage is distributed over the duration of the {{taglink|beamTime}}, and the weapon will aim to hit the target when the beam is in the middle of its {{taglink|beamTime}} (i.e. using prediction).<br />
}}<br />
<br />
{{tag<br />
|name = beamBurst<br />
|type = bool<br />
|default = false<br />
|description = Makes the laser fire a burst of beams that are all aimed towards the target (instead of aimed with the piece). A [[#BeamLaser]] can do its full damage with every shot if {{taglink|beamBurst}} is enabled. Disables {{taglink|beamTime}} in favour of the [[#Bursts|burst tags]].<br />
}}<br />
<br />
{{tag<br />
|name = sweepFire<br />
|type = bool<br />
|default = false<br />
|description = Makes the laser continue firing while it aims for a new target, 'sweeping' across the terrain. Reimplemented in 95.0, still has no script interaction so use with care. Respects {{taglink|reloadTime}} constraint but not much else.<br />
}}<br />
<br />
====BeamLaser Visuals====<br />
<br />
See also {{taglink|thickness}} and {{taglink|coreThickness}}.<br />
<br />
{{tag<br />
|name = beamTTL<br />
|type = int<br />
|default = 0<br />
|description = The time in frames for which the laser beam remains visible.<br />
}}<br />
<br />
{{tag<br />
|name = beamDecay<br />
|type = float<br />
|default = 1.0<br />
|description = How fast the beam fades out. Each frame the {{taglink|intensity}} is multiplied by this value.<br />
}}<br />
<br />
{{tag<br />
|name = laserFlareSize<br />
|type = float<br />
|default = 15.0<br />
|description = Determines the size of the firing flare.<br />
}}<br />
<br />
{{tag<br />
|name = largeBeamLaser<br />
|type = bool<br />
|default = false<br />
|description = Changes the visual effect allowing tiling and scrolling of the texture and a pulsating firing flare.<br />
}}<br />
<br />
{{tag<br />
|name = tileLength<br />
|type = float<br />
|default = 200.0<br />
|description = Defines the length before the texture used is repeated (tiled). Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
{{tag<br />
|name = scrollSpeed<br />
|type = float<br />
|default = 5.0<br />
|description = Controls how fast the texture scrolls. Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
{{tag<br />
|name = pulseSpeed<br />
|type = float<br />
|default = 1.0<br />
|description = Controls how fast the pulsating effect at the start of the beam is. Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
===Cannon===<br />
The default '''WeaponType'''. Fires a ballistic projectile, for the best result (without under/overshooting) the {{taglink|weaponVelocity}} should be set so as to give an elevation of 45° when firing at the maximum {{taglink|range}}. Substituting the angle into the [http://en.wikipedia.org/wiki/Trajectory#Range_and_height trajectory equation] and rearranging, we get: <br />
<code><pre>weaponVelocity = √(range * g)</pre></code> <br />
where <code>g</code> is the map gravity, usually around <code>120</code> for most Spring maps (You can use the {{taglink|myGravity}} tag if you want to be exact). Visually drawn as a billboarded sprite or 3D model. <br />
<br />
{{tag<br />
|name = highTrajectory<br />
|type = int<br />
|default = 2<br />
|description = Can this weapon be fired in a high trajectory (>45° angle). Can be <code>0</code> - low trajectory only, <code>1</code> - high trajectory only or <code>2</code> - enables a high/low toggle button on the unit.<br />
}}<br />
<br />
{{tag<br />
|name = heightBoostFactor<br />
|type = float<br />
|default = -1.0<br />
|description = Controls the boost given to {{taglink|range}} by high terrain. Values > <code>1.0</code> result in increased range, <code>0.0</code> means the cannon has fixed range regardless of height difference to target. Any value < <code>0.0</code> (i.e. the default value) result in an automatically calculated value based on {{taglink|range}} and theoretical maximum range.<br />
}}<br />
<br />
====Cannon Visuals====<br />
<br />
{{tag<br />
|name = size<br />
|type = float<br />
|default = 2.0 + min(default_damage * 0.0025, {{taglink|areaOfEffect}} * 0.1)<br />
|description = The drawing radius of the billboarded sprite. Also for [[#AircraftBomb Visuals]], [[#EmgCannon Visuals]] (default: <code>3.0</code>) and [[#Flame Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = colorMap<br />
|type = string<br />
|default = ""<br />
|description = A set of RGB colours to transition between over the projectile's lifetime. Can be given as a string of RGB digits or an image filename (See [[CColorMap]]). Also for [[#Flame Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = sizeDecay<br />
|type = float<br />
|default = 0.0<br />
|description = How quickly each particle of the Cannon shot decays in size.<br />
}}<br />
<br />
{{tag<br />
|name = alphaDecay<br />
|type = float<br />
|default = 1.0<br />
|description = How quickly each particle of the Cannon shot fades out.<br />
}}<br />
<br />
{{tag<br />
|name = separation<br />
|type = float<br />
|default = 0.0<br />
|description = The distance between each particle of the Cannon shot.<br />
}}<br />
<br />
{{tag<br />
|name = noGap<br />
|type = bool<br />
|default = true<br />
|description = Switch between the distance between particles being proportional to the size of the two particles (<code>true</code>) or proportional to the size of the first particle (<code>false</code>). <br />
}}<br />
<br />
{{tag<br />
|name = stages<br />
|type = int<br />
|default = 5<br />
|description = The number of particles in each Cannon shot.<br />
}}<br />
<br />
===DGun===<br />
Fires a line-of-sight or ballistic projectile (selected via the {{taglink|gravityAffected}} tag). Visually represented by a fireball effect that cannot be customised, however it can be replaced by a 3D model. The name and visual effect are [[OTAism]]s.<br />
<br />
{{tag<br />
|name = gravityAffected<br />
|type = bool<br />
|default = false<br />
|description = Does the fireball projectile lose height due to map gravity?<br />
}}<br />
<br />
===EmgCannon===<br />
A line-of-sight weapon. Visually drawn as a billboarded sprite very similar to that of the [[#Cannon]], however not as customisable, or a 3D model. The name is another [[OTAism]].<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Flame===<br />
A line-of-sight weapon intended for use as a flamethrower or similar. Visually drawn as a stream of textured particles, the colour of which can be controlled very precisely using the {{taglink|colorMap}} tag (see [[CColorMap]]).<br />
<br />
====Flame Visuals====<br />
See also {{taglink|colorMap}}.<br />
<br />
{{tag<br />
|name = sizeGrowth<br />
|type = float<br />
|default = 0.5<br />
|description = How much the draw radius of the flame projectile increases each frame.<br />
}}<br />
<br />
{{tag<br />
|name = flameGFXTime<br />
|type = float<br />
|default = 1.2<br />
|description = Makes the flamethrower projectile stay alive as a visual-only effect (i.e. does not deal any damage) after it has reached maximum {{taglink|range}}. It is a percentage multiplier, e.g. <code>1.2</code> makes the projectile stay alive until it reaches 20% beyond {{taglink|range}}.<br />
}}<br />
<br />
===LaserCannon===<br />
A particularly versatile line-of-sight weapon. Visually drawn like a [http://en.wikipedia.org/wiki/Star_Wars Star Wars] Blaster-style laser weapon, or a 3D model.<br />
<br />
====LaserCannon Visuals====<br />
<br />
{{tag<br />
|name = duration<br />
|type = float<br />
|default = 0.05<br />
|description = Multiplied against {{taglink|weaponVelocity}} to determine the visual length of the beam projectile.<br />
}}<br />
<br />
{{tag<br />
|name = hardStop<br />
|type = bool<br />
|default = false<br />
|description = Does the laser projectile stop dead or fade out?<br />
}}<br />
<br />
{{tag<br />
|name = fallOffRate<br />
|type = float<br />
|default = 0.5<br />
|description = Rate at which the beam fades out after it goes past its maximum {{taglink|range}} if {{taglink|hardStop|false}}. A value of <code>0.0</code> is never fade out, <code>1.0</code> is finish fading out exactly at maximum {{taglink|range}}.<br />
}}<br />
<br />
{{tag<br />
|name = lodDistance<br />
|type = int<br />
|default = 1000<br />
|description = Minimum camera distance at which the default LaserCannon projectile is simplified to a single rectangle.<br />
}}<br />
<br />
{{tag<br />
|name = thickness<br />
|type = float<br />
|default = 2.0<br />
|description = The thickness (width) of the LaserCannon projectile. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = coreThickness<br />
|type = float<br />
|default = 2.0<br />
|description = The thickness (width) of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = rgbColor2<br />
|type = float<br />
|default = {1.0, 1.0, 1.0}<br />
|description = The colour of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
===LightningCannon===<br />
An instant-hit weapon similar to the [[#BeamLaser]], but which does all its damage at once. Visually drawn like [http://en.wikipedia.org/wiki/Star_Wars Star Wars] 'Force Lightning' or [http://en.wikipedia.org/wiki/Command_%26_Conquer:_Red_Alert CnC: Red Alert] [http://en.wikipedia.org/wiki/Tesla_coil Tesla Coil] weapons, the effect is not very customisable.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Melee===<br />
A weapon that always damages the target, no ifs or buts; unsurprisingly intended for use as a close quarters [http://en.wikipedia.org/wiki/Melee#Use_in_gaming 'melee'] weapon. It does not fire a projectile and does not care about the line of fire.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===MissileLauncher===<br />
A versatile weapon which can optionally track targets and accelerate from a low initial velocity. It can also use {{taglink|trajectoryHeight}} to have the shot arc similar to a ballistic projectile. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.<br />
<br />
{{tag<br />
|name = startVelocity<br />
|type = float<br />
|default = 0.0<br />
|description = The initial velocity of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = weaponAcceleration<br />
|type = float<br />
|default = 0.0<br />
|description = The initial acceleration of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Note that if it is <code>0.0</code> the weapon can never increase from its {{taglink|startVelocity}} and will not reach its maximum {{taglink|weaponVelocity}}. Since 99.0 <code>acceleration</code> is a synonym.<br />
}}<br />
<br />
{{tag<br />
|name = tracks<br />
|type = bool<br />
|default = false<br />
|description = Can the weapon projectile track a moving target? Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].}}<br />
<br />
{{tag<br />
|name = turnRate<br />
|type = float<br />
|default = 0.0<br />
|description = The rate (in [[Elmo#Angular|cau]]) at which {{taglink|tracks|true}} weapons turn towards their target. This is relative to a projectile's current velocity; a weapon with a higher velocity will need a higher value in order to be able to hit targets that turn suddenly.}}<br />
<br />
{{tag<br />
|name = flightTime<br />
|type = float<br />
|default = 0.0<br />
|description = The time in seconds before a missile projectile's fuel runs out; it ceases to obey {{taglink|tracks}}, loses velocity and falls to the ground. Also for [[#StarburstLauncher]]. Large values may cause over/undershoot problems.<br />
}}<br />
<br />
{{tag<br />
|name = fixedLauncher<br />
|type = bool<br />
|default = false<br />
|description = Makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Weapons may not correctly obey [[#Collision & Avoidance|avoidance settings]] when using this tag.<br />
}}<br />
<br />
{{tag<br />
|name = wobble<br />
|type = float<br />
|default = 0.0<br />
|description = Adds a random vector to the direction of travel every 16 frames, multiplied by the value of the tag. The effect is reduced as the firing unit gains experience. As this missiles direction is changed, wobbling swarm of missiles will diverge.<br />
}}<br />
<br />
{{tag<br />
|name = dance<br />
|type = float<br />
|default = 0.0<br />
|description = Adds a random vector to the position of a missile projectile every 8 frames, multiplied by the value of the tag. As the projectile is not rotated, a dancing swarm of missiles will remain relatively coherent.<br />
}}<br />
<br />
{{tag<br />
|name = trajectoryHeight<br />
|type = float<br />
|default = 0.0<br />
|description = Determines the height of the arc the missile will reach as it moves towards its target. A value of <code>0.0</code> will result in a flat trajectory, <code>1.0</code> will launch at 45&deg;. Can be any value >= <code>0.0</code>; extreme values may require the {{taglink|tracks}} tag to be able to hit a target.<br />
}}<br />
<br />
====MissileLauncher Visuals====<br />
A note about the missile exhaust flare: the size of the flare is determined by the model radius. The emit position of the flare is at (0,0,-radius) so the model may need careful adjustment to get the flare looking right.<br />
<br />
{{tag<br />
|name = smokeTrail<br />
|type = bool<br />
|default = false<br />
|description = Does the missile projectile emit a smoke trail as it travels? Also for [[#StarburstLauncher]].<br />
}}<br />
<br />
===Rifle===<br />
An instant hit weapon which does all its damage at once. Visually represented by a hardcoded tracer, firing and hitting effects. Rarely used.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Shield (WeaponType)===<br />
As the name suggests, not a weapon but a defensive shield. Can absorb or deflect ({{taglink|repulsor|true}}) projectiles. Individual weapons can be set to be intercepted or not by the shield using a [http://en.wikipedia.org/wiki/Mask_(computing) bitmask] (see [[Shield Interception Tag Use]]). Visually represented as a translucent sphere, with control over colour and texture; by default the shield is invisible ({{taglink|visible|false}}).<br />
<br />
See the [[#shield]] sub-table section for other tags specific to this type.<br />
<br />
===StarburstLauncher===<br />
Fires a projectile that rises vertically for {{taglink|weaponTimer}} seconds, then turns towards its target. It can optionally track targets and accelerate from a low initial velocity. Before spring 92.0 was the only weapon that can be {{taglink|targetable}} and act as an {{taglink|interceptor}}. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.<br />
<br />
{{tag<br />
|name = weaponTimer<br />
|type = float<br />
|default = 0.0<br />
|description = The time in seconds during which the missile ascends vertically before turning towards its target.<br />
}}<br />
<br />
===TorpedoLauncher===<br />
Fires a projectile that will behave ballistically out of water and like a missile in water. Usually used with {{taglink|waterWeapon|true}} so they can fire underwater and target underwater units. An aircraft carrying a [[#TorpedoLauncher]] is a special case, the weapon turns into an [[#AircraftBomb]] projectile that will spawn a torpedo projectile on impact with water. Visually represented by a pointed black cuboid, usually the default object is replaced by a 3D model. <br />
<br />
{{tag<br />
|name = subMissile<br />
|type = bool<br />
|default = false<br />
|description = Can the torpedo leave the water and target units and positions on land?<br />
}}<br />
<br />
===NoWeapon===<br />
Not actually a '''WeaponType''', but an individual weapon requested by Spring to 'fill in the gaps' if a unit claims to have a weapon which isn't actually defined. There needs to be only one of these weapons and it is created by setting {{taglink|weaponName|"NOWEAPON"}} rather than by the {{taglink|weaponType}} tag.<br />
<br />
==Sub Tables==<br />
<br />
===damage===<br />
The damage subtable lists how many hit points the weapon depletes against each armor class (See [[Armordefs.lua]]). It is a key-value map of armor class names and damage values. The special <code>default</code> entry is as the name suggests the default damage applied to any unit which does not belong to a listed armor class, or to shields.<br />
<br />
For example a weapon which deals 100 damage by default but only 50 to units in the 'tank' armor class:<br />
<br />
<code><pre>damage = {<br />
default = 100,<br />
tank = 50,<br />
}</pre></code><br />
<br />
===shield===<br />
The preferred way to create a shield or repulser is to use the shield subtable rather than the old shield tags. <br />
<br />
The following tags are repulser specific:<br />
<br />
{{tag<br />
|name = repulser<br />
|type = bool<br />
|default = false<br />
|description = Does the shield [http://dictionary.reference.com/browse/repulse?s=t repulse] (deflect) projectiles or absorb them? Btw its [http://springrts.com/mantis/view.php?id=4206 not repulsOr, but repulsEr]!}}<br />
<br />
{{tag<br />
|name = force<br />
|type = float<br />
|default = 0.0<br />
|description = The force applied by the repulser to the weapon - higher values will deflect weapons away at higher velocities.}}<br />
<br />
{{tag<br />
|name = maxSpeed<br />
|type = float<br />
|default = 0.0<br />
|description = The maximum speed the repulser will impart to deflected projectiles.}}<br />
<br />
{{tag<br />
|name = visibleRepulse<br />
|type = bool<br />
|default = false<br />
|description = Is the (hard-coded) repulse effect rendered or not?}}<br />
<br />
The following tags are general behaviour for all shields:<br />
<br />
{{tag<br />
|name = interceptType<br />
|type = int<br />
|default = 0<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this shield can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptedByShieldType}} will be intercepted by this shield (See [[Shield Interception Tag Use]]).}}<br />
<br />
{{tag<br />
|name = armorType<br />
|type = string<br />
|default = ""<br />
|description = Specifies the armorclass of the shield; you can input either an [[Armordefs.lua|armorclass]] name OR a unitdef {{xtaglink|Gamedev:UnitDefs|name}} to share that unit's armorclass.}}<br />
<br />
{{tag<br />
|name = smart<br />
|type = bool<br />
|default = false<br />
|description = Determines whether or not projectiles fired by allied units can pass through the shield (<code>true</code>) or are intercepted as enemy weapons are (<code>false</code>).}}<br />
<br />
{{tag<br />
|name = exterior<br />
|type = bool<br />
|default = false<br />
|description = Determines whether or not projectiles fired within the shield's radius can pass through the shield (<code>true</code>) or are intercepted (<code>false</code>).}}<br />
<br />
{{tag<br />
|name = energyUse<br />
|type = float<br />
|default = 0.0<br />
|description = The amount of the energy resource consumed by the shield to absorb or repulse weapons, continually drained by a repulser as long as the projectile is in range.}}<br />
<br />
{{tag<br />
|name = radius<br />
|type = float<br />
|default = 0.0<br />
|description = The radius of the circular area the shield covers.}}<br />
<br />
{{tag<br />
|name = power<br />
|type = float<br />
|default = 0.0<br />
|description = Essentially the maximum allowed hit-points of the shield - reduced by the <code>damage</code> of a weapon upon impact.}}<br />
<br />
{{tag<br />
|name = startingPower<br />
|type = float<br />
|default = 0.0<br />
|description = How many hit-points the shield starts with - otherwise the shield must regenerate from <code>0</code> until it reaches maximum {{taglink|power}}.}}<br />
<br />
{{tag<br />
|name = powerRegen<br />
|type = float<br />
|default = 0.0<br />
|description = How many hit-points the shield regenerates each second.}}<br />
<br />
{{tag<br />
|name = powerRegenEnergy<br />
|type = float<br />
|default = 0.0<br />
|description = How much energy resource is consumed to regenerate each hit-point.}}<br />
<br />
{{tag<br />
|name = rechargeDelay<br />
|type = float<br />
|default = 0.0<br />
|description = The delay in seconds before a shield begins to regenerate after it is hit.}}<br />
<br />
The following tags control the visual aspects of the shield:<br />
<br />
{{tag<br />
|name = visible<br />
|type = bool<br />
|default = false<br />
|description = Is the shield visible or not?}}<br />
<br />
{{tag<br />
|name = visibleHitFrames<br />
|type = int<br />
|default = 0<br />
|description = The number of frames a shield becomes visible for when hit.}}<br />
<br />
{{tag<br />
|name = badColor<br />
|type = float[3]<br />
|default = {1.0, 0.5, 0.5} (Red)<br />
|description = The RGB colour the shield transitions to as its hit-points are reduced towards <code>0</code>.}}<br />
<br />
{{tag<br />
|name = goodColor<br />
|type = float[3]<br />
|default = {0.5, 0.5, 1.0} (Blue)<br />
|description = The RGB colour the shield transitions to as its hit-points are regenerated towards its maximum {{taglink|power}}.}}<br />
<br />
{{tag<br />
|name = alpha<br />
|type = float<br />
|default = 0.2<br />
|description = The alpha transparency of the shield whilst it is visible.}}<br />
<br />
===customParams===<br />
The <code>customParams</code> subtable of a WeaponDef allows the game designer to give their weapons custom attributes, which can then be accessed via lua gadgets and widgets. It is a map (key-value pair indexed table) of strings. When accessing these attributes in lua the strings can be turned back into numbers, bools or even tables. This gives great control to game designers to essentially implement their own behaviour tags.<br />
<br />
There are no additional tags specific to this subtable<br />
<br />
==Examples==<br />
Some games may have most WeaponDefs integrated into their [[Gamedev:UnitDefs#Examples|UnitDefs]].<br />
<br />
S44 and MC:L implement an [http://en.wikipedia.org/wiki/Object-oriented_programming OOP] paradigm with [http://en.wikipedia.org/wiki/Inheritance_(computer_science) inheritance].<br />
<br />
<br />
{{ExampleRepoLinks<br />
|path = weapons/<br />
|entity = WeaponDefs<br />
}}<br />
<br />
[[Category: Game Dev]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Gamedev:WeaponDefs&diff=8803Gamedev:WeaponDefs2015-11-19T20:31:22Z<p>Anarchid: /* Collision & Avoidance */ collisionSize hate edit</p>
<hr />
<div>[[Gamedev:Main|Development]] < [[Gamedev:Main]] < {{FULLPAGENAME}}<br />
<br />
==Location==<br />
WeaponDef files are .lua files stored in the <code>Weapons/</code> directory of a Spring Game. Alternatively they can be integrated into [[Gamedev:UnitDefs|UnitDefs]].<br />
<br />
==Purpose==<br />
WeaponDef files have one purpose; to define the properties of weapons. They are the main description file for what attributes your weapon should have and how it should behave. Since version 100.0, Spring will record a warning whenever it finds an unknown tag.<br />
<br />
==Source==<br />
The engine source code which loads the tags from these files is viewable here:<br />
<br />
* {{sourcelink|file=rts/Sim/Weapons/WeaponDef.cpp}}<br />
<br />
==Data Types==<br />
{{DataTypes}}<br />
<br />
==Details==<br />
There follows a comprehensive (certain deprecated tags are not present) list of the tags available, their data type, default value and a brief description of what they do. Bear in mind that the source code linked above is the ultimate reference when dealing with these tags. <br />
<br />
In lua tables keys (i.e. the tags) should be lower case, here they are represented in camelCase for readability. In your files you may use the <code>lowerkeys</code> function on your final table to ensure the keys are properly cased.<br />
<br />
It is usual to name the returned WeaponDef table the internal <code>weaponName</code> desired for the weapon.<br />
<br />
===Common===<br />
The following tags are common to all or at least a majority of '''WeaponTypes''', depending on the tag.<br />
<br />
====General====<br />
{{tag<br />
|name = weaponType<br />
|type = string<br />
|default = "Cannon"<br />
|description = Spring has 14 '''WeaponTypes''' which provide game developers with basic behaviours which they can customise to an extent with the '''WeaponDef''' tags. Some tags are specific to certain '''WeaponTypes''' and not implemented for others, [https://docs.google.com/spreadsheet/ccc?key=0Am5BbZxm93S9dEZXc1Q4dXR4TFRYTFM4NlR4OFJFdWc#gid=0 this two-way table] indicates which tags work for which types.}} The possible values are:<br />
* [[#AircraftBomb|AircraftBomb]]<br />
* [[#BeamLaser|BeamLaser]]<br />
* [[#Cannon|Cannon]]<br />
* [[#DGun|Dgun]]<br />
* [[#EmgCannon|EmgCannon]]<br />
* [[#Flame|Flame]]<br />
* [[#LaserCannon|LaserCannon]]<br />
* [[#LightningCannon|LightningCanon]]<br />
* [[#Melee|Melee]]<br />
* [[#MissileLauncher|MissileLauncher]]<br />
* [[#Rifle|Rifle]]<br />
* [[#Shield (WeaponType)|Shield]]<br />
* [[#StarburstLauncher|StarburstLauncher]]<br />
* [[#TorpedoLauncher|TorpedoLauncher]]<br />
<br />
{{tag<br />
|name = name<br />
|type = string<br />
|default = "Weapon"<br />
|description = The descriptive name of the weapon as listed in FPS mode.}}<br />
<br />
{{tag<br />
|name = turret<br />
|type = bool<br />
|default = false<br />
|description = Does the unit aim within an arc (up-to and including full 360° turret traverse) or always aim along the owner's heading?}}<br />
<br />
{{tag<br />
|name = noSelfDamage<br />
|type = bool<br />
|default = false<br />
|description = Can the weapon's explosion damage the unit which fires it? Useful for preventing bombers with high-yield weapons destroying themselves.}}<br />
<br />
{{tag<br />
|name = impactOnly<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon only deal damage through direct hits and not 'splash' damage through {{taglink|areaOfEffect}}?}}<br />
<br />
{{tag<br />
|name = noExplode<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon explode on impact with a target or continue through? Note that these weapons will do damage every single frame they are inside the [[Gamedev:CollisionVolumes|collision volume]] of an object, underground or under water, massively multiplying their damage.}}<br />
<br />
{{tag<br />
|name = burnblow<br />
|type = bool<br />
|default = false<br />
|special = lua: selfExplode<br />
|description = Does the weapon explode when it reaches its maximum range or continue on its path? The name is an [[OTAism]].}}<br />
<br />
{{tag<br />
|name = range<br />
|type = float<br />
|default = 10.0<br />
|description = The maximum range in [[elmo]]s that the weapon can fire at.}}<br />
<br />
{{tag<br />
|name = weaponVelocity<br />
|type = float<br />
|default = 0.0<br />
|description = The velocity in [[elmo]]s per second of the weapon projectile. Since 99.0 <code>maxVelocity</code> is a synonym.}}<br />
<br />
{{tag<br />
|name = reloadTime<br />
|type = float<br />
|default = 1.0<br />
|description = The time in seconds between shots fired.}}<br />
<br />
{{tag<br />
|name = metalPerShot<br />
|type = float<br />
|default = 0.0<br />
|description = 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 {{taglink|stockpile}} weapon will cost to build.}}<br />
<br />
{{tag<br />
|name = energyPerShot<br />
|type = float<br />
|default = 0.0<br />
|description = Energy used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a {{taglink|stockpile}} weapon will cost to build.}}<br />
<br />
{{tag<br />
|name = myGravity<br />
|type = float<br />
|default = 0.0<br />
|description = Overrides the map gravity for ballistic weapons. The default of <code>0.0</code> disables the tag in favour of map gravity.}}<br />
<br />
{{tag<br />
|name = fireStarter<br />
|type = float<br />
|default = 0.0<br />
|description = The percentage chance (<code>0.0</code> to <code>100.0</code>) of the weapon setting fire to static map features on impact.}}<br />
<br />
{{tag<br />
|name = cameraShake<br />
|type = float<br />
|default = damage (0.0 for paralyzers)<br />
|description = Passed to the [[LuaCallinReturn#Game_Events:|ShockFront() callin]] as the first argument. Intended as a means to make the camera shake if in range of detonation.}}<br />
<br />
{{tag<br />
|name = stockpile<br />
|type = bool<br />
|default = false<br />
|description = Does each round of the weapon have to be built and stockpiled by the player? Will only correctly function for the first of each stockpiled weapons a unit has.}}<br />
<br />
{{tag<br />
|name = stockpileTime<br />
|type = float<br />
|default = reloadTime<br />
|description = The time in seconds taken to stockpile one round of the weapon.}}<br />
<br />
{{tag<br />
|name = interceptedByShieldType<br />
|type = int<br />
|default = Depends on {{taglink|weaponType}}<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of shields that can intercept this weapon. Each digit of binary that is set to one means that a shield with the corresponding digit in its {{taglink|interceptType}} will intercept this weapon. A value of <code>0</code> means that no shields will intercept the weapon. The defaults are as follows:<br />
* <code>0</code> - [[#DGun]]<br />
* <code>1</code> - [[#Cannon]] and [[#EmgCannon]]<br />
* <code>2</code> - [[#LaserCannon]] and [[#BeamLaser]]<br />
* <code>4</code> - [[#MissileLauncher]] and [[#StarburstLauncher]]<br />
* <code>8</code> - [[#AircraftBomb]]<br />
* <code>16</code> - [[#Flame]]<br />
* <code>32</code> - [[#TorpedoLauncher]]<br />
* <code>64</code> - [[#LightningCannon]]<br />
* <code>128</code> - [[#Rifle]]<br />
* <code>256</code> - [[#Melee]]<br />
(See [[Shield Interception Tag Use]]).}}<br />
<br />
====Collision & Avoidance====<br />
<br />
{{tag<br />
|name = avoidGround<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if terrain blocks the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidFriendly<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if a friendly unit is in the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidFeature<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if a static map feature is in the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidNeutral<br />
|type = bool<br />
|default = false<br />
|description = Should the weapon avoid firing if a neutral unit is in the line of fire?}}<br />
<br />
{{tag<br />
|name = collideEnemy<br />
|type = bool<br />
|default = true<br />
|special = lua: noEnemyCollide<br />
|description = Does the weapon projectile collide with enemy units or pass through?}}<br />
<br />
{{tag<br />
|name = collideFriendly<br />
|type = bool<br />
|default = true<br />
|special = lua: noFriendlyCollide<br />
|description = Does the weapon projectile collide with friendly units or pass through?}}<br />
<br />
{{tag<br />
|name = collideFeature<br />
|type = bool<br />
|default = true<br />
|special = lua: noFeatureCollide<br />
|description = Does the weapon projectile collide with static map features or pass through?}}<br />
<br />
{{tag<br />
|name = collideNeutral<br />
|type = bool<br />
|default = true<br />
|special = lua: noNeutralCollide<br />
|description = Does the weapon projectile collide with neutral units or pass through?}}<br />
<br />
{{tag<br />
|name = collideGround<br />
|type = bool<br />
|default = true<br />
|special = lua: noGroundCollide<br />
|description = Does the weapon projectile collide with terrain or pass through?}}<br />
<br />
{{tag<br />
|name = collisionSize<br />
|type = float<br />
|default = 0.05 (0.5 for [[#Flame]] and [[#LaserCannon]], 10.0 for [[#Dgun]])<br />
|description = Modifies size of EMG and Flame projectiles, and physical size '''only''' for [https://github.com/spring/spring/blob/3034e5f5a8f5b9fb4624a97f7a85cb5c90457725/rts/Sim/Projectiles/WeaponProjectiles/WeaponProjectile.cpp#L250 hitscan] interceptor weapons (e.g. antinuke lasers).<br />
<br />
====Targeting & Accuracy====<br />
{{tag<br />
|name = commandFire<br />
|type = bool<br />
|default = false<br />
|description = Determines if the weapon will automatically fire on enemy units in range or only when manually ordered to attack.}}<br />
<br />
{{tag<br />
|name = canAttackGround<br />
|type = bool<br />
|default = true<br />
|description = Determines if the weapon can be force-fired on ground positions or only fire on targeted units.}}<br />
<br />
{{tag<br />
|name = waterWeapon<br />
|type = bool<br />
|default = false<br />
|description = Determines if the weapon can pass through water and target underwater units.}}<br />
<br />
{{tag<br />
|name = fireSubmersed<br />
|type = bool<br />
|default = waterWeapon<br />
|description = Determines if the weapon can fire whilst underwater.}}<br />
<br />
{{tag<br />
|name = targetBorder<br />
|type = float<br />
|default = 0.0 (1.0 for [[#Melee]])<br />
|description = Controls whether the weapon aims for the centre or the edge of its target's [[Gamedev:CollisionVolumes|collision volume]]. Clamped between <code>-1.0</code> - target the far border, and <code>1.0</code> - target the near border.}}<br />
<br />
{{tag<br />
|name = cylinderTargeting<br />
|type = float<br />
|default = 0.0 (1.0 for [[#Melee]])<br />
|description = Controls whether the weapon range is calculated in a sphere or a cylinder. The height of the cylinder is determined by the value of this tag multiplied by the {{taglink|range}}. Clamped between <code>0.0</code> and <code>128.0</code>.}}<br />
<br />
{{tag<br />
|name = tolerance<br />
|type = float<br />
|default = 3000.0 (+/- ~18 degrees)<br />
|description = The amount (in [[Gamedev:UnitsOfMeasurement#Angular|cau]]) to which the weapon's "real" aim can be off while the weapon will still be able to fire accurately at the target. For {{taglink|turret|false}} or {{taglink|fixedLauncher|true}} weapons this determines in what arc the unit will fire.}}<br />
<br />
{{tag<br />
|name = fireTolerance<br />
|type = float<br />
|default = 32768.0 (+/- 180 degrees)<br />
|special = {{new|99.0}}<br />
|description = Final check to prevent weapons from shooting sideways. If a weapon is about to fire but the difference between its old aim and requested aim is greater than this angle (in [[Gamedev:UnitsOfMeasurement#Angular|cau]]) then it will not fire.}}<br />
<br />
{{tag<br />
|name = allowNonBlockingAim<br />
|type = bool<br />
|default = false<br />
|special = {{new|99.0}}<br />
|description = When enabled it makes [[Animation-LuaCallins#Weapons|AimWeapon()]] script calls non-blocking (still the {{taglink|fireTolerance}} tag might prevent the weapon firing). This is very useful for fast units that need to re-target often.}}<br />
<br />
{{tag<br />
|name = targetMoveError<br />
|type = float<br />
|default = 0.0<br />
|description = 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.}}<br />
<br />
{{tag<br />
|name = leadLimit<br />
|type = float<br />
|default = -1.0<br />
|description = Limits the maximum distance a unit will lead a target. The default of <code>-1</code> allows an infinite distance.}}<br />
<br />
{{tag<br />
|name = leadBonus<br />
|type = float<br />
|default = 0.0<br />
|description = Controls how experience boosts the weapon's target leading. Is multiplied with the unit's experience and added to the {{taglink|leadLimit}}.}}<br />
<br />
{{tag<br />
|name = predictBoost<br />
|type = float<br />
|default = 0.0 (0.5 for {{taglink|burnblow|true}} weapons)<br />
|description = Controls how well the weapon predicts unit speeds. Works in a similar way to {{taglink|targetMoveError}} except that it is 1-dimensional. This tag spreads the shots in a line based on the direction of the target whereas {{taglink|targetMoveError}} spreads the shots all around based on the movement.}}<br />
<br />
{{tag<br />
|name = heightMod<br />
|type = float<br />
|default = 0.2 (0.8 for [[#Cannon]], 1.0 for [[#BeamLaser]] and [[#LightningCannon]])<br />
|description = Changes the spherical weapon range into an ellipsoid. Values above <code>1.0</code> mean the weapon cannot target as high as it can far, values below <code>1.0</code> mean it can target higher than it can far. For example <code>0.5</code> would allow the weapon to target twice as high as far.}}<br />
<br />
{{tag<br />
|name = proximityPriority<br />
|type = float<br />
|default = 1.0<br />
|description = Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets.}}<br />
<br />
{{tag<br />
|name = accuracy<br />
|type = float<br />
|default = 0.0<br />
|description = How accurate the weapon is. Lower values are more accurate. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high value will probably still hit. If a target is very far away, even a very low value will likely cause the weapon to miss.}}<br />
<br />
{{tag<br />
|name = movingAccuracy<br />
|type = float<br />
|default = accuracy<br />
|description = A weapon's {{taglink|accuracy}} whilst the owning unit is moving.}}<br />
<br />
{{tag<br />
|name = sprayAngle<br />
|type = float<br />
|default = 0.0<br />
|description = How wide the the angle of a burst from a [[#Bursts|burst weapon]] can be. Very similar to {{taglink|accuracy}}, except that this tag affects each projectile in a burst, whilst the former does not.}}<br />
<br />
{{tag<br />
|name = ownerExpAccWeight<br />
|type = float<br />
|default = 0.0 (See description)<br />
|description = A multiplier to {{taglink|accuracy}} and {{taglink|sprayAngle}} that reduces inaccuracy as a units experience increases. Defaults are as follows:<br />
* <code>0.9</code> - [[#Cannon]], [[#Rifle]]<br />
* <code>0.7</code> - [[#LaserCannon]], [[#BeamLaser]], [[#StarburstLauncher]]<br />
* <code>0.5</code> - [[#MissileLauncher]], [[#LightningCannon]], [[#EmgCannon]], [[#DGun]]<br />
* <code>0.2</code> - [[#Flame]]<br />
}}<br />
<br />
{{tag<br />
|name = targetable<br />
|type = int<br />
|default = 0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapon that can intercept this weapon. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptor}} tag will intercept this weapon. Instant-hitting weapons such as [[#BeamLaser]], [[#LightningCannon]] and [[#Rifle]] cannot be targeted.<br />
}}<br />
<br />
{{tag<br />
|name = interceptor<br />
|type = int<br />
|default = 0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this weapon can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|targetable}} tag will be intercepted by this weapon.<br />
}}<br />
<br />
{{tag<br />
|name = interceptSolo<br />
|type = bool<br />
|default = true<br />
|special = {{new|92.0}} <br />
|description = If <code>true</code> no other interceptors may target the same projectile.<br />
}}<br />
<br />
{{tag<br />
|name = coverage<br />
|type = float<br />
|default = 0.0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = The radius in [[elmo]]s within which an {{taglink|interceptor}} weapon will fire on {{taglink|targetable}} weapons.<br />
}}<br />
<br />
====Bouncing====<br />
<br />
{{tag<br />
|name = waterBounce<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon bounce on water impacts?}}<br />
<br />
{{tag<br />
|name = groundBounce<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon bounce on ground impacts?}}<br />
<br />
{{tag<br />
|name = bounceSlip<br />
|type = float<br />
|default = 1.0<br />
|description = The decimal-percentage amount of horizontal velocity a projectile keeps when it bounces.}}<br />
<br />
{{tag<br />
|name = bounceRebound<br />
|type = float<br />
|default = 1.0<br />
|description = The decimal-percentage amount of vertical velocity a projectile keeps when it bounces.}}<br />
<br />
{{tag<br />
|name = numBounce<br />
|type = int<br />
|default = -1<br />
|description = The number of times the weapon will bounce on impact before exploding. The default value of <code>-1</code> allows infinite bounces (at least until velocity reaches 0).}}<br />
<br />
====Area Of Effect, Impulse & Cratering====<br />
<br />
{{tag<br />
|name = areaOfEffect<br />
|type = float<br />
|default = 8.0 * 0.5<br />
|special = lua: damageAreaOfEffect<br />
|description = The ''diameter'' in [[elmo]]s in which the weapons explosion will cause damage.}}<br />
<br />
{{tag<br />
|name = craterAreaOfEffect<br />
|type = float<br />
|default = areaOfEffect * 0.5<br />
|description = The ''radius'' in [[elmo]]s in which the weapons explosion will cause terrain cratering. Behaviour changed slightly in 98.0 as previously craters were 1.5x {{taglink|craterAreaOfEffect}} whilst decals were 1.0x, they are now both the same size.}}<br />
<br />
{{tag<br />
|name = edgeEffectiveness<br />
|type = float<br />
|default = 0.0<br />
|description = Determines what percent of a weapon's maximum damage value will be applied to units within the weapon's {{taglink|areaOfEffect}}. Falls off from the epicentre according to the formula <code>damageApplied = damage * [(areaOfEffect - distToUnit) / (areaOfEffect - (distToUnit * edgeEffectiveness))]</code>, a graph of the function for various values is available [[Media:EdgeEffectiveness.png|here]].}}<br />
<br />
{{tag<br />
|name = explosionSpeed<br />
|type = float<br />
|default = See description<br />
|description = The speed at which the weapon's explosion propagates from the epicentre. The default is calculated by this complex formula: <code>defExpSpeed = {8.0 + [max(30.0, default_damage / 20.0) * 2.5]} / {9.0f + [sqrt(max(30.0, default_damage / 20.0f)) * 0.7]} * 0.5</code>.}}<br />
<br />
{{tag<br />
|name = impulseFactor<br />
|type = float<br />
|default = 1.0<br />
|description = A multiplier to the impulse given to units within the explosion {{taglink|areaOfEffect}}, which is otherwise equal to the damage dealt after {{taglink|edgeEffectiveness}} is taken into account. For [[#Melee]] weapons this is instead multiplied by the owning unit's mass (See [[Gamedev:UnitDefs#Tag:mass|Gamedev:UnitDefs]]).}}<br />
<br />
{{tag<br />
|name = impulseBoost<br />
|type = float<br />
|default = 0.0<br />
|description = A constant amount added to the weapon's impulse, regardless of distance from the epicentre or the damage potential of the explosion, prior to the application of {{taglink|impulseFactor}}}}<br />
<br />
{{tag<br />
|name = craterMult<br />
|type = float<br />
|default = impulseFactor<br />
|description = A multiplier to depth of terrain crater the weapon's explosion will create, which is otherwise based on the damage potential.}}<br />
<br />
{{tag<br />
|name = craterBoost<br />
|type = float<br />
|default = 0.0<br />
|description = A constant amount, added to the weapon's cratering depth before the application of {{taglink|craterMult}}.}}<br />
<br />
====Bursts====<br />
<br />
{{tag<br />
|name = burst<br />
|type = int<br />
|default = 1<br />
|special = lua: salvoSize<br />
|description = How many shots to fire per burst.<br />
}}<br />
<br />
{{tag<br />
|name = burstRate<br />
|type = float<br />
|default = 0.1<br />
|special = lua: salvoDelay<br />
|description = The time in seconds between shots in a burst. Note that {{taglink|reloadTime}} starts to count down from the ''first'' round fired, not the last so if <code>reloadTime < burst * burstRate</code> the weapon will fire continuously.<br />
}}<br />
<br />
{{tag<br />
|name = projectiles<br />
|type = int<br />
|default = 1<br />
|description = How many projectiles released per shot (shotgun style). e.g. a weapon with {{taglink|burst|5}}, {{taglink|burstRate|0.5}} and {{taglink|projectiles|2}} will shoot 5 lots of 2 for 10 projectiles total, with gaps of 0.5 seconds, before waiting for {{taglink|reloadTime}}. Best used in conjunction with {{taglink|sprayAngle}} or changing the firing piece using [[Animation-LuaCallins#Weapons|ShotX]] as otherwise they'll all be clumped in one shot.<br />
}}<br />
<br />
====Paralyzing====<br />
{{tag<br />
|name = paralyzer<br />
|type = bool<br />
|default = false<br />
|description = Is the weapon a paralyzer? If <code>true</code> the weapon only stuns enemy units and does not cause damage in the form of lost hit-points.<br />
}}<br />
<br />
{{tag<br />
|name = paralyzeTime<br />
|type = int<br />
|default = 10<br />
|special = lua: damages.paralyzeDamageTime<br />
|description = Determines the maximum length of time in seconds that the target will be paralyzed. The timer is restarted every time the target is hit by the weapon. Cannot be less than <code>0</code>.<br />
}}<br />
<br />
====Dynamic Damage====<br />
The following set of tags allow for a weapon's damage potential to vary with the distance to its target.<br />
<br />
{{tag<br />
|name = dynDamageExp<br />
|type = float<br />
|default = 0.0<br />
|description = Exponent of the range-dependent damage formula, the default of <code>0.0</code> disables dynamic damage, <code>1.0</code> means linear scaling, <code>2.0</code> quadratic and so on.<br />
}}<br />
<br />
{{tag<br />
|name = dynDamageMin<br />
|type = float<br />
|default = 0.0<br />
|description = The minimum floor value that range-dependent damage can drop to.<br />
}}<br />
<br />
{{tag<br />
|name = dynDamageRange<br />
|type = float<br />
|default = 0.0<br />
|description = If set to non-zero values the weapon will use this value in the range-dependant damage formula instead of the actual {{taglink|range}}. <br />
}}<br />
<br />
{{tag<br />
|name = dynDamageInverted<br />
|type = bool<br />
|default = false<br />
|description = If <code>true</code> the damage curve is inverted i.e. the weapon does more damage at greater ranges as opposed to less.<br />
}}<br />
<br />
====Sounds====<br />
{{tag<br />
|name = soundTrigger<br />
|type = bool<br />
|default = false (true for [[#Melee]], [[#Rifle]] and non-beamBurst [[#BeamLaser]])<br />
|description = Does the weapon play {{taglink|soundStart}} only once for each salvo (<code>true</code>) or for every round in a burst (<code>false</code>)?}}<br />
<br />
{{tag<br />
|name = soundStart<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon fires.}}<br />
<br />
{{tag<br />
|name = soundHitDry<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with solid ground. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}<br />
<br />
{{tag<br />
|name = soundHitWet<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with water. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}<br />
<br />
====Visuals====<br />
<br />
{{tag<br />
|name = cegTag<br />
|type = string<br />
|default = ""<br />
|description = The name, without prefixes, of a [[CEG]] to be emitted by the projectile each frame.<br />
}}<br />
<br />
{{tag<br />
|name = intensity<br />
|type = float<br />
|default = 0.9 (0.2 for [[#Cannon]])<br />
|description = Alpha transparency for non-3D model projectiles. Lower values are more opaque, but <code>0.0</code> will cause the projectile to disappear entirely.<br />
}}<br />
<br />
{{tag<br />
|name = model<br />
|type = string<br />
|default = ""<br />
|description = The filename of a 3D model to use when rendering the projectile. Note that only the root piece of a projectile model is rendered. Currently only for [[#Cannon]], [[#LaserCannon]], [[#MissileLauncher]], [[#StarburstLauncher]] and [[#TorpedoLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = explosionScar<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon's explosion leave a scar decal on the ground? For all types except [[#Melee]] and [[#Rifle]].<br />
}}<br />
<br />
{{tag<br />
|name = alwaysVisible<br />
|type = bool<br />
|default = false<br />
|description = If <code>true</code> the weapon is always rendered regardless of whether or not it is in LOS range of a player's units.<br />
}}<br />
<br />
{{tag<br />
|name = rgbColor<br />
|type = float[3]<br />
|default = {1.0, 0.0, 0.0} (See Description)<br />
|description = The primary colour for sprite rendering weapons. Additional defaults are as follows:<br />
* [[#Cannon]] - <code>{1.0, 0.5, 0.0}</code><br />
* [[#EmgCannon]] - <code>{0.9, 0.9, 0.2}</code><br />
}}<br />
<br />
{{tag<br />
|name = explosionGenerator<br />
|type = string<br />
|default = ""<br />
|description = The name of a [[CEG]], with <code>custom:</code> prefix, to spawn as the weapon's explosion. Does not currently work for [[#Melee]] and [[#Rifle]].<br />
}}<br />
<br />
{{tag<br />
|name = bounceExplosionGenerator<br />
|type = string<br />
|default = ""<br />
|description = For weapons which can use {{taglink|groundBounce|true}}, the name of a [[CEG]], with <code>custom:</code> prefix, to spawn when weapon the bounces.<br />
}}<br />
<br />
{{tag<br />
|name = texture1<br />
|type = string<br />
|default = ""<br />
|description = The projectile texture for [[#AircraftBomb]], [[#Cannon]], [[#EmgCannon]], [[#Flame]]; beam texture for [[#LaserCannon]], [[#BeamLaser]], [[#LightningCannon]]; flare texture for [[#MissileLauncher]], [[#StarburstLauncher]] and dome texture for the [[#Shield]].<br />
}}<br />
<br />
{{tag<br />
|name = texture2<br />
|type = string<br />
|default = ""<br />
|description = The end-of-beam texture for [[#LaserCannon]], [[#BeamLaser]] and {{taglink|smoketrail}} texture for [[#MissileLauncher]], [[#StarburstLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = texture3<br />
|type = string<br />
|default = ""<br />
|description = Flare texture for [[#BeamLaser]], or muzzle texture if {{taglink|largeBeamLaser|true}}. Also used as the flame texture for [[#StarburstLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = texture4<br />
|type = string<br />
|default = ""<br />
|description = Flare texture for [[#BeamLaser]] with {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
===AircraftBomb===<br />
Drops a ballistic projectile at the same movement vector as the unit itself. Intended only for aircraft. Visually drawn as a billboarded sprite as used by the [[#Cannon]], but more commonly used with a 3D model.<br />
<br />
There are no tags specific to this '''WeaponType'''<br />
<br />
====AircraftBomb Visuals====<br />
<br />
When not using a {{taglink|model}}, the AircraftBomb is the same as [[#Cannon Visuals]].<br />
<br />
===BeamLaser===<br />
An instant-hit weapon which spawns a beam and does a portion of its total damage each frame. Cannot be [[Animation-LuaCallouts#Effects|script emitted]] if it has a {{taglink|beamTime}} longer than one frame. Visually drawn as a [http://en.wikipedia.org/wiki/Star_Trek Star Trek] Phaser-style laser weapon. The {{taglink|largeBeamLaser}} tag allows changing the visual effect of the laser, such as using a tileable, scrolling texture without changing the behaviour.<br />
<br />
{{tag<br />
|name = minIntensity<br />
|type = float<br />
|default = 0.0<br />
|description = The minimum percentage the weapon's damage can fall-off to over its range. Setting to <code>1.0</code> will disable fall off entirely. Unrelated to the visual-only {{taglink|intensity}} tag.<br />
}}<br />
<br />
{{tag<br />
|name = beamTime<br />
|type = float<br />
|default = 1.0<br />
|description = How long in seconds to fire the laser before waiting for {{taglink|reloadTime}} to start. Damage is distributed over the duration of the {{taglink|beamTime}}, and the weapon will aim to hit the target when the beam is in the middle of its {{taglink|beamTime}} (i.e. using prediction).<br />
}}<br />
<br />
{{tag<br />
|name = beamBurst<br />
|type = bool<br />
|default = false<br />
|description = Makes the laser fire a burst of beams that are all aimed towards the target (instead of aimed with the piece). A [[#BeamLaser]] can do its full damage with every shot if {{taglink|beamBurst}} is enabled. Disables {{taglink|beamTime}} in favour of the [[#Bursts|burst tags]].<br />
}}<br />
<br />
{{tag<br />
|name = sweepFire<br />
|type = bool<br />
|default = false<br />
|description = Makes the laser continue firing while it aims for a new target, 'sweeping' across the terrain. Reimplemented in 95.0, still has no script interaction so use with care. Respects {{taglink|reloadTime}} constraint but not much else.<br />
}}<br />
<br />
====BeamLaser Visuals====<br />
<br />
See also {{taglink|thickness}} and {{taglink|coreThickness}}.<br />
<br />
{{tag<br />
|name = beamTTL<br />
|type = int<br />
|default = 0<br />
|description = The time in frames for which the laser beam remains visible.<br />
}}<br />
<br />
{{tag<br />
|name = beamDecay<br />
|type = float<br />
|default = 1.0<br />
|description = How fast the beam fades out. Each frame the {{taglink|intensity}} is multiplied by this value.<br />
}}<br />
<br />
{{tag<br />
|name = laserFlareSize<br />
|type = float<br />
|default = 15.0<br />
|description = Determines the size of the firing flare.<br />
}}<br />
<br />
{{tag<br />
|name = largeBeamLaser<br />
|type = bool<br />
|default = false<br />
|description = Changes the visual effect allowing tiling and scrolling of the texture and a pulsating firing flare.<br />
}}<br />
<br />
{{tag<br />
|name = tileLength<br />
|type = float<br />
|default = 200.0<br />
|description = Defines the length before the texture used is repeated (tiled). Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
{{tag<br />
|name = scrollSpeed<br />
|type = float<br />
|default = 5.0<br />
|description = Controls how fast the texture scrolls. Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
{{tag<br />
|name = pulseSpeed<br />
|type = float<br />
|default = 1.0<br />
|description = Controls how fast the pulsating effect at the start of the beam is. Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
===Cannon===<br />
The default '''WeaponType'''. Fires a ballistic projectile, for the best result (without under/overshooting) the {{taglink|weaponVelocity}} should be set so as to give an elevation of 45° when firing at the maximum {{taglink|range}}. Substituting the angle into the [http://en.wikipedia.org/wiki/Trajectory#Range_and_height trajectory equation] and rearranging, we get: <br />
<code><pre>weaponVelocity = √(range * g)</pre></code> <br />
where <code>g</code> is the map gravity, usually around <code>120</code> for most Spring maps (You can use the {{taglink|myGravity}} tag if you want to be exact). Visually drawn as a billboarded sprite or 3D model. <br />
<br />
{{tag<br />
|name = highTrajectory<br />
|type = int<br />
|default = 2<br />
|description = Can this weapon be fired in a high trajectory (>45° angle). Can be <code>0</code> - low trajectory only, <code>1</code> - high trajectory only or <code>2</code> - enables a high/low toggle button on the unit.<br />
}}<br />
<br />
{{tag<br />
|name = heightBoostFactor<br />
|type = float<br />
|default = -1.0<br />
|description = Controls the boost given to {{taglink|range}} by high terrain. Values > <code>1.0</code> result in increased range, <code>0.0</code> means the cannon has fixed range regardless of height difference to target. Any value < <code>0.0</code> (i.e. the default value) result in an automatically calculated value based on {{taglink|range}} and theoretical maximum range.<br />
}}<br />
<br />
====Cannon Visuals====<br />
<br />
{{tag<br />
|name = size<br />
|type = float<br />
|default = 2.0 + min(default_damage * 0.0025, {{taglink|areaOfEffect}} * 0.1)<br />
|description = The drawing radius of the billboarded sprite. Also for [[#AircraftBomb Visuals]], [[#EmgCannon Visuals]] (default: <code>3.0</code>) and [[#Flame Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = colorMap<br />
|type = string<br />
|default = ""<br />
|description = A set of RGB colours to transition between over the projectile's lifetime. Can be given as a string of RGB digits or an image filename (See [[CColorMap]]). Also for [[#Flame Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = sizeDecay<br />
|type = float<br />
|default = 0.0<br />
|description = How quickly each particle of the Cannon shot decays in size.<br />
}}<br />
<br />
{{tag<br />
|name = alphaDecay<br />
|type = float<br />
|default = 1.0<br />
|description = How quickly each particle of the Cannon shot fades out.<br />
}}<br />
<br />
{{tag<br />
|name = separation<br />
|type = float<br />
|default = 0.0<br />
|description = The distance between each particle of the Cannon shot.<br />
}}<br />
<br />
{{tag<br />
|name = noGap<br />
|type = bool<br />
|default = true<br />
|description = Switch between the distance between particles being proportional to the size of the two particles (<code>true</code>) or proportional to the size of the first particle (<code>false</code>). <br />
}}<br />
<br />
{{tag<br />
|name = stages<br />
|type = int<br />
|default = 5<br />
|description = The number of particles in each Cannon shot.<br />
}}<br />
<br />
===DGun===<br />
Fires a line-of-sight or ballistic projectile (selected via the {{taglink|gravityAffected}} tag). Visually represented by a fireball effect that cannot be customised, however it can be replaced by a 3D model. The name and visual effect are [[OTAism]]s.<br />
<br />
{{tag<br />
|name = gravityAffected<br />
|type = bool<br />
|default = false<br />
|description = Does the fireball projectile lose height due to map gravity?<br />
}}<br />
<br />
===EmgCannon===<br />
A line-of-sight weapon. Visually drawn as a billboarded sprite very similar to that of the [[#Cannon]], however not as customisable, or a 3D model. The name is another [[OTAism]].<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Flame===<br />
A line-of-sight weapon intended for use as a flamethrower or similar. Visually drawn as a stream of textured particles, the colour of which can be controlled very precisely using the {{taglink|colorMap}} tag (see [[CColorMap]]).<br />
<br />
====Flame Visuals====<br />
See also {{taglink|colorMap}}.<br />
<br />
{{tag<br />
|name = sizeGrowth<br />
|type = float<br />
|default = 0.5<br />
|description = How much the draw radius of the flame projectile increases each frame.<br />
}}<br />
<br />
{{tag<br />
|name = flameGFXTime<br />
|type = float<br />
|default = 1.2<br />
|description = Makes the flamethrower projectile stay alive as a visual-only effect (i.e. does not deal any damage) after it has reached maximum {{taglink|range}}. It is a percentage multiplier, e.g. <code>1.2</code> makes the projectile stay alive until it reaches 20% beyond {{taglink|range}}.<br />
}}<br />
<br />
===LaserCannon===<br />
A particularly versatile line-of-sight weapon. Visually drawn like a [http://en.wikipedia.org/wiki/Star_Wars Star Wars] Blaster-style laser weapon, or a 3D model.<br />
<br />
====LaserCannon Visuals====<br />
<br />
{{tag<br />
|name = duration<br />
|type = float<br />
|default = 0.05<br />
|description = Multiplied against {{taglink|weaponVelocity}} to determine the visual length of the beam projectile.<br />
}}<br />
<br />
{{tag<br />
|name = hardStop<br />
|type = bool<br />
|default = false<br />
|description = Does the laser projectile stop dead or fade out?<br />
}}<br />
<br />
{{tag<br />
|name = fallOffRate<br />
|type = float<br />
|default = 0.5<br />
|description = Rate at which the beam fades out after it goes past its maximum {{taglink|range}} if {{taglink|hardStop|false}}. A value of <code>0.0</code> is never fade out, <code>1.0</code> is finish fading out exactly at maximum {{taglink|range}}.<br />
}}<br />
<br />
{{tag<br />
|name = lodDistance<br />
|type = int<br />
|default = 1000<br />
|description = Minimum camera distance at which the default LaserCannon projectile is simplified to a single rectangle.<br />
}}<br />
<br />
{{tag<br />
|name = thickness<br />
|type = float<br />
|default = 2.0<br />
|description = The thickness (width) of the LaserCannon projectile. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = coreThickness<br />
|type = float<br />
|default = 2.0<br />
|description = The thickness (width) of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = rgbColor2<br />
|type = float<br />
|default = {1.0, 1.0, 1.0}<br />
|description = The colour of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
===LightningCannon===<br />
An instant-hit weapon similar to the [[#BeamLaser]], but which does all its damage at once. Visually drawn like [http://en.wikipedia.org/wiki/Star_Wars Star Wars] 'Force Lightning' or [http://en.wikipedia.org/wiki/Command_%26_Conquer:_Red_Alert CnC: Red Alert] [http://en.wikipedia.org/wiki/Tesla_coil Tesla Coil] weapons, the effect is not very customisable.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Melee===<br />
A weapon that always damages the target, no ifs or buts; unsurprisingly intended for use as a close quarters [http://en.wikipedia.org/wiki/Melee#Use_in_gaming 'melee'] weapon. It does not fire a projectile and does not care about the line of fire.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===MissileLauncher===<br />
A versatile weapon which can optionally track targets and accelerate from a low initial velocity. It can also use {{taglink|trajectoryHeight}} to have the shot arc similar to a ballistic projectile. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.<br />
<br />
{{tag<br />
|name = startVelocity<br />
|type = float<br />
|default = 0.0<br />
|description = The initial velocity of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = weaponAcceleration<br />
|type = float<br />
|default = 0.0<br />
|description = The initial acceleration of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Note that if it is <code>0.0</code> the weapon can never increase from its {{taglink|startVelocity}} and will not reach its maximum {{taglink|weaponVelocity}}. Since 99.0 <code>acceleration</code> is a synonym.<br />
}}<br />
<br />
{{tag<br />
|name = tracks<br />
|type = bool<br />
|default = false<br />
|description = Can the weapon projectile track a moving target? Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].}}<br />
<br />
{{tag<br />
|name = turnRate<br />
|type = float<br />
|default = 0.0<br />
|description = The rate (in [[Elmo#Angular|cau]]) at which {{taglink|tracks|true}} weapons turn towards their target. This is relative to a projectile's current velocity; a weapon with a higher velocity will need a higher value in order to be able to hit targets that turn suddenly.}}<br />
<br />
{{tag<br />
|name = flightTime<br />
|type = float<br />
|default = 0.0<br />
|description = The time in seconds before a missile projectile's fuel runs out; it ceases to obey {{taglink|tracks}}, loses velocity and falls to the ground. Also for [[#StarburstLauncher]]. Large values may cause over/undershoot problems.<br />
}}<br />
<br />
{{tag<br />
|name = fixedLauncher<br />
|type = bool<br />
|default = false<br />
|description = Makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Weapons may not correctly obey [[#Collision & Avoidance|avoidance settings]] when using this tag.<br />
}}<br />
<br />
{{tag<br />
|name = wobble<br />
|type = float<br />
|default = 0.0<br />
|description = Adds a random vector to the direction of travel every 16 frames, multiplied by the value of the tag. The effect is reduced as the firing unit gains experience. As this missiles direction is changed, wobbling swarm of missiles will diverge.<br />
}}<br />
<br />
{{tag<br />
|name = dance<br />
|type = float<br />
|default = 0.0<br />
|description = Adds a random vector to the position of a missile projectile every 8 frames, multiplied by the value of the tag. As the projectile is not rotated, a dancing swarm of missiles will remain relatively coherent.<br />
}}<br />
<br />
{{tag<br />
|name = trajectoryHeight<br />
|type = float<br />
|default = 0.0<br />
|description = Determines the height of the arc the missile will reach as it moves towards its target. A value of <code>0.0</code> will result in a flat trajectory, <code>1.0</code> will launch at 45&deg;. Can be any value >= <code>0.0</code>; extreme values may require the {{taglink|tracks}} tag to be able to hit a target.<br />
}}<br />
<br />
====MissileLauncher Visuals====<br />
A note about the missile exhaust flare: the size of the flare is determined by the model radius. The emit position of the flare is at (0,0,-radius) so the model may need careful adjustment to get the flare looking right.<br />
<br />
{{tag<br />
|name = smokeTrail<br />
|type = bool<br />
|default = false<br />
|description = Does the missile projectile emit a smoke trail as it travels? Also for [[#StarburstLauncher]].<br />
}}<br />
<br />
===Rifle===<br />
An instant hit weapon which does all its damage at once. Visually represented by a hardcoded tracer, firing and hitting effects. Rarely used.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Shield (WeaponType)===<br />
As the name suggests, not a weapon but a defensive shield. Can absorb or deflect ({{taglink|repulsor|true}}) projectiles. Individual weapons can be set to be intercepted or not by the shield using a [http://en.wikipedia.org/wiki/Mask_(computing) bitmask] (see [[Shield Interception Tag Use]]). Visually represented as a translucent sphere, with control over colour and texture; by default the shield is invisible ({{taglink|visible|false}}).<br />
<br />
See the [[#shield]] sub-table section for other tags specific to this type.<br />
<br />
===StarburstLauncher===<br />
Fires a projectile that rises vertically for {{taglink|weaponTimer}} seconds, then turns towards its target. It can optionally track targets and accelerate from a low initial velocity. Before spring 92.0 was the only weapon that can be {{taglink|targetable}} and act as an {{taglink|interceptor}}. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.<br />
<br />
{{tag<br />
|name = weaponTimer<br />
|type = float<br />
|default = 0.0<br />
|description = The time in seconds during which the missile ascends vertically before turning towards its target.<br />
}}<br />
<br />
===TorpedoLauncher===<br />
Fires a projectile that will behave ballistically out of water and like a missile in water. Usually used with {{taglink|waterWeapon|true}} so they can fire underwater and target underwater units. An aircraft carrying a [[#TorpedoLauncher]] is a special case, the weapon turns into an [[#AircraftBomb]] projectile that will spawn a torpedo projectile on impact with water. Visually represented by a pointed black cuboid, usually the default object is replaced by a 3D model. <br />
<br />
{{tag<br />
|name = subMissile<br />
|type = bool<br />
|default = false<br />
|description = Can the torpedo leave the water and target units and positions on land?<br />
}}<br />
<br />
===NoWeapon===<br />
Not actually a '''WeaponType''', but an individual weapon requested by Spring to 'fill in the gaps' if a unit claims to have a weapon which isn't actually defined. There needs to be only one of these weapons and it is created by setting {{taglink|weaponName|"NOWEAPON"}} rather than by the {{taglink|weaponType}} tag.<br />
<br />
==Sub Tables==<br />
<br />
===damage===<br />
The damage subtable lists how many hit points the weapon depletes against each armor class (See [[Armordefs.lua]]). It is a key-value map of armor class names and damage values. The special <code>default</code> entry is as the name suggests the default damage applied to any unit which does not belong to a listed armor class, or to shields.<br />
<br />
For example a weapon which deals 100 damage by default but only 50 to units in the 'tank' armor class:<br />
<br />
<code><pre>damage = {<br />
default = 100,<br />
tank = 50,<br />
}</pre></code><br />
<br />
===shield===<br />
The preferred way to create a shield or repulser is to use the shield subtable rather than the old shield tags. <br />
<br />
The following tags are repulser specific:<br />
<br />
{{tag<br />
|name = repulser<br />
|type = bool<br />
|default = false<br />
|description = Does the shield [http://dictionary.reference.com/browse/repulse?s=t repulse] (deflect) projectiles or absorb them? Btw its [http://springrts.com/mantis/view.php?id=4206 not repulsOr, but repulsEr]!}}<br />
<br />
{{tag<br />
|name = force<br />
|type = float<br />
|default = 0.0<br />
|description = The force applied by the repulser to the weapon - higher values will deflect weapons away at higher velocities.}}<br />
<br />
{{tag<br />
|name = maxSpeed<br />
|type = float<br />
|default = 0.0<br />
|description = The maximum speed the repulser will impart to deflected projectiles.}}<br />
<br />
{{tag<br />
|name = visibleRepulse<br />
|type = bool<br />
|default = false<br />
|description = Is the (hard-coded) repulse effect rendered or not?}}<br />
<br />
The following tags are general behaviour for all shields:<br />
<br />
{{tag<br />
|name = interceptType<br />
|type = int<br />
|default = 0<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this shield can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptedByShieldType}} will be intercepted by this shield (See [[Shield Interception Tag Use]]).}}<br />
<br />
{{tag<br />
|name = armorType<br />
|type = string<br />
|default = ""<br />
|description = Specifies the armorclass of the shield; you can input either an [[Armordefs.lua|armorclass]] name OR a unitdef {{xtaglink|Gamedev:UnitDefs|name}} to share that unit's armorclass.}}<br />
<br />
{{tag<br />
|name = smart<br />
|type = bool<br />
|default = false<br />
|description = Determines whether or not projectiles fired by allied units can pass through the shield (<code>true</code>) or are intercepted as enemy weapons are (<code>false</code>).}}<br />
<br />
{{tag<br />
|name = exterior<br />
|type = bool<br />
|default = false<br />
|description = Determines whether or not projectiles fired within the shield's radius can pass through the shield (<code>true</code>) or are intercepted (<code>false</code>).}}<br />
<br />
{{tag<br />
|name = energyUse<br />
|type = float<br />
|default = 0.0<br />
|description = The amount of the energy resource consumed by the shield to absorb or repulse weapons, continually drained by a repulser as long as the projectile is in range.}}<br />
<br />
{{tag<br />
|name = radius<br />
|type = float<br />
|default = 0.0<br />
|description = The radius of the circular area the shield covers.}}<br />
<br />
{{tag<br />
|name = power<br />
|type = float<br />
|default = 0.0<br />
|description = Essentially the maximum allowed hit-points of the shield - reduced by the <code>damage</code> of a weapon upon impact.}}<br />
<br />
{{tag<br />
|name = startingPower<br />
|type = float<br />
|default = 0.0<br />
|description = How many hit-points the shield starts with - otherwise the shield must regenerate from <code>0</code> until it reaches maximum {{taglink|power}}.}}<br />
<br />
{{tag<br />
|name = powerRegen<br />
|type = float<br />
|default = 0.0<br />
|description = How many hit-points the shield regenerates each second.}}<br />
<br />
{{tag<br />
|name = powerRegenEnergy<br />
|type = float<br />
|default = 0.0<br />
|description = How much energy resource is consumed to regenerate each hit-point.}}<br />
<br />
{{tag<br />
|name = rechargeDelay<br />
|type = float<br />
|default = 0.0<br />
|description = The delay in seconds before a shield begins to regenerate after it is hit.}}<br />
<br />
The following tags control the visual aspects of the shield:<br />
<br />
{{tag<br />
|name = visible<br />
|type = bool<br />
|default = false<br />
|description = Is the shield visible or not?}}<br />
<br />
{{tag<br />
|name = visibleHitFrames<br />
|type = int<br />
|default = 0<br />
|description = The number of frames a shield becomes visible for when hit.}}<br />
<br />
{{tag<br />
|name = badColor<br />
|type = float[3]<br />
|default = {1.0, 0.5, 0.5} (Red)<br />
|description = The RGB colour the shield transitions to as its hit-points are reduced towards <code>0</code>.}}<br />
<br />
{{tag<br />
|name = goodColor<br />
|type = float[3]<br />
|default = {0.5, 0.5, 1.0} (Blue)<br />
|description = The RGB colour the shield transitions to as its hit-points are regenerated towards its maximum {{taglink|power}}.}}<br />
<br />
{{tag<br />
|name = alpha<br />
|type = float<br />
|default = 0.2<br />
|description = The alpha transparency of the shield whilst it is visible.}}<br />
<br />
===customParams===<br />
The <code>customParams</code> subtable of a WeaponDef allows the game designer to give their weapons custom attributes, which can then be accessed via lua gadgets and widgets. It is a map (key-value pair indexed table) of strings. When accessing these attributes in lua the strings can be turned back into numbers, bools or even tables. This gives great control to game designers to essentially implement their own behaviour tags.<br />
<br />
There are no additional tags specific to this subtable<br />
<br />
==Examples==<br />
Some games may have most WeaponDefs integrated into their [[Gamedev:UnitDefs#Examples|UnitDefs]].<br />
<br />
S44 and MC:L implement an [http://en.wikipedia.org/wiki/Object-oriented_programming OOP] paradigm with [http://en.wikipedia.org/wiki/Inheritance_(computer_science) inheritance].<br />
<br />
<br />
{{ExampleRepoLinks<br />
|path = weapons/<br />
|entity = WeaponDefs<br />
}}<br />
<br />
[[Category: Game Dev]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=AI:Development:Lang:Java&diff=654AI:Development:Lang:Java2015-09-23T12:41:44Z<p>Anarchid: /* Links */</p>
<hr />
<div>[[Engine_Development|Development]] < [[AI:Development|AI Development]] < Java AI Development<br />
<br />
== Getting Started on your own Java AI ==<br />
<br />
''Note:'' This tutorial assumes you have Spring working on your machine. The Spring directory will be referred to as 'Spring' from here on.<br />
<br />
You will also need to make sure that Java AI's run properly on your machine. This is most easily done by running a Spring game with the ''NullOOJavaAI'' that comes with the engine. You will need the JRE 1.5 or greater, and to set the ''JAVA_HOME'' environment variable on your system to point to the correct location.<br />
<br />
''Note:'' If you're using a ''64 bit'' version of ''Windows'', you will need a 32 bit Java Runtime Environment/Java Development Kit anyway, because Spring is (as of May 2014) not yet available as a 64bit version for Windows.<br />
<br />
<br />
=== Setting up a Java Project ===<br />
<br />
To start working on your own Java AI, you should first set up a project in your favorite Java IDE. You need to import the Spring Java AI Interface libraries, and then create an AI class and an AI Factory.<br />
<br />
'''OUTDATED''' If you are using '''Netbeans IDE''', you can find a detailed tutorial [http://springrts.com/phpbb/download/file.php?id=4970 here] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread]). Otherwise, please continue reading this page.<br />
<br />
==== Importing the interface libraries ====<br />
<br />
In order to use the Java Interface, you will need to import the Java Interface libraries (optionally, you can attach the sources for JavaDoc support in your editor) <br />
<br />
* <code>Spring/AI/Interfaces/Java/[version]/AIInterface.jar</code> (sources: jlib/AIInterface-src.jar</code>)<br />
* <code>Spring/AI/Skirmish/NullOOJavaAI/0.1/jlib/vecmath.jar</code> (sources: vecmath-src.jar)<br />
* <code>JavaOO-AIWrapper.jar</code> (sources: TODO)<br />
<br />
==== Creating the main class ====<br />
<br />
Now that you have the libraries, the next step is to create your AI's main class. Firstly, you may want to create a package to put your classes in, for example, ''myjavaai''. Create a new class, named MyJavaAI (or whatever you would like your AI to be called). MyJavaAI should extend com.springrts.ai.oo.AbstractOOAI.<br />
<br />
=== Adding your AI to Spring ===<br />
<br />
Your AI needs to have its own folder, and the engine will need to know your AI's attributes.<br />
<br />
<br />
==== Creating an AI folder ====<br />
<br />
Every Spring AI is stored in ''Spring/AI/Skirmish''. You will have to create a folder for your AI as well. It is easiest to go to the directory ''Spring/AI/Skirmish'', make a copy of the folder ''NullOOJavaAI'', and rename the copy to ''MyJavaAI''.<br />
<br />
<br />
==== Telling the Engine about your AI ====<br />
<br />
The ''MyJavaAI'' folder you created contains the different versions of your AI. As of this writing, the ''NullOOJavaAI'' only has a version ''0.1'', so there should be a folder ''0.1'' inside the ''MyJavaAI'' folder. Inside you will find a number of files.<br />
These files are:<br />
* ''SkirmishAI.jar'': the jar file that contains the AI code.<br />
* ''AIInfo.lua'': contains information about the AI.<br />
* ''AIOptions.lua'': you can specify your AI's options in here.<br />
* Possibly some text files: these are log files generated by the ''NullOOJavaAI''. If you don't plan on using the same files, you may as well delete these.<br />
<br />
Additionally, there is a folder named ''jlib''. This is where you should place any additional libraries you use in your AI.<br />
<br />
In order to let Spring recognize your AI, you will have to edit ''AIInfo.lua''. You can do this with any regular text editor.<br />
When you open it, the file will look something like this:<br />
<br />
<code><pre><br />
local infos = {<br />
{<br />
key = 'shortName',<br />
value = 'NullOOJavaAI',<br />
desc = 'machine conform name.',<br />
},<br />
{<br />
key = 'version',<br />
value = '0.1', -- AI version - !This comment is used for parsing!<br />
},<br />
{<br />
key = 'className',<br />
value = 'nulloojavaai.NullOOJavaAI',<br />
desc = 'fully qualified name of a class that implements interface com.springrts.ai.AI',<br />
},<br />
{<br />
key = 'name',<br />
value = 'high-level Java stub Skirmish AI',<br />
desc = 'human readable name.',<br />
},<br />
{<br />
key = 'loadSupported',<br />
value = 'no',<br />
desc = 'whether this AI supports loading or not',<br />
},<br />
{<br />
key = 'interfaceShortName',<br />
value = 'Java', -- AI Interface name - !This comment is used for parsing!<br />
desc = 'the shortName of the AI interface this AI needs',<br />
},<br />
{<br />
key = 'interfaceVersion',<br />
value = '0.1', -- AI Interface version - !This comment is used for parsing!<br />
desc = 'the minimum version of the AI interface required by this AI',<br />
},<br />
}<br />
<br />
return infos<br />
</pre></code><br />
<br />
<br />
The file describes a number of attributes. Each attribute has a key, a value and a desc(ription). The key is the name of the attribute, the description tells you what the attribute is used for, and the value is what you will want to edit.<br />
<br />
The shortName attribute is the name used for your AI internally. It's most logical to change this into to the same name you gave your AI class. (MyJavaAI.)<br />
<br />
'version' tells the engine which version of your AI this is. If you're in the 0.1 folder, make this 0.1. Your AI should be located at AI/Skirmish/''shortName''/''version''/.<br />
<br />
'classname' tells the interface which class is your AIFactory class. Take care that you use the fully qualified class name, or it won't work. In this example, this should be myjavaai.MyJavaAIFactory.<br />
<br />
'name' describes your AI to the user. In this example, you might put 'A simple Java AI to learn about AI programming in Spring.'<br />
<br />
'loadSupported' is rather self-explanatory. Since you have just started working on your AI, you may not get around to implementing loading support for some time, so it's best to put 'no,' for now.<br />
<br />
'interfaceShortName' and 'interfaceversion' tell the engine about the interface your AI uses. Since MyJavaAI uses the same interface as the NullOOJavaAI, leave these as they are.<br />
<br />
<br />
Finally, the last thing you should do is exporting your AI to SkirmishAI.jar. The way to do this varies depending on your Java editor.<br />
<br />
=== Test your AI ===<br />
<br />
<br />
After following all the above steps, you should be able to run your AI. Either use SpringLobby to start a new game and see if you can add your AI as a bot, or run ''spring.exe'' to see if you can start the script MyJavaAI Test.<br />
Of course, since you haven't told the AI what to do, your starting unit(s) will sit there doing nothing.<br />
<br />
== Getting your AI to Do Something ==<br />
<br />
<br />
After getting your AI running, you will want to make it do something. Traditionally, the first thing to get your AI to is to build a solar plant, assuming you want it to play BA. If not, it is quite straightforward to build other units once you have the general idea.<br />
You will need four things to get your AI to build a solar plant:<br />
* A reference to the callback<br />
* A reference to the commander (your starting unit in BA)<br />
* A reference to the solar plant definition object<br />
* To tell the commander to build the solar plant<br />
<br />
However, before we go about building solar plants, first you should know about events. We will use these to get the required object references.<br />
<br />
<br />
=== Events ===<br />
<br />
Nearly everything that happens in the game is an event. When a unit is created, this is an event. Enemy spotted? Also an event. A player sends your AI a message? You got it, this is an event as well.<br />
<br />
Every event is made known to your AI. Have a look at the <code>MyJavaAI</code> class again. <code>MyJavaAI</code> extends <code>AbstractOOA</code>. <code>AbstractOOAI</code> implements a number of methods like <code>unitCreated()</code>, <code>enemyEnterRadar()</code> and <code>message()</code>.<br />
Sound familiar? The method <code>unitCreated(Unit unit, Unit builder)</code> is called every time a unit is created, and tells you the unit that was created and the unit that built it. Similarly, enemyEnterRadar(Unit enemy) and message(int player, String message) tell you about an enemy unit entering radar range and receiving a message from another player respectively.<br />
There are many other events that all have corresponding methods. To have your AI respond to these events, simply override the method in your <code>MyJavaAI</code> class.<br />
The return type of these methods is an integer. The return value can be used for debugging. 0 means that no errors occurred, while any other value is threated as an error. This system can be used for debugging, but is it much easier to implement proper logging.<br />
<br />
In the sections below you will see an example of the use of these events.<br />
<br />
<br />
=== Getting a reference to the callback ===<br />
<br />
The callback is the object through which the AI communicates with the engine. All information that does not change the state of the engine can be retrieved through individual methods in the callback, and state changing commands (eg to units) will go through a single, specialized method, which is in the callback as well.<br />
Getting a reference to the callback is easy.<br />
First create a class field <code>OOAICallback callback</code> to put the reference in, then overwrite the method <code>init(int teamId, OOAICallback callback)</code>. The init method is called at the start of every game (right at the end of the countdown).<br />
As you can see, all that you need to do is set the parameter value callback to the field callback:<br />
<br />
<code><pre><br />
@Override<br />
public int init(int teamId, OOAICallback callback)<br />
{<br />
this.callback = callback;<br />
return 0;<br />
}<br />
</pre></code><br />
<br />
=== Getting a reference to the commander ===<br />
<br />
Whenever a unit has been built, the engine sends a unitFinished event. At the start of the game, the engine will send a UnitFinished event for every starting unit. When playing BA, this means you will get a UnitFinished event for the commander. Therefore, the most straightforward way of finding the reference to the commander is overriding the <code>unitFinished()</code> method:<br />
<br />
<code><pre><br />
@Override<br />
public int unitFinished(Unit unit) {<br />
if (unit.getDef().getName().equals("armcom")) {<br />
commander = unit;<br />
}<br />
<br />
return 0;<br />
}<br />
</pre></code><br />
<br />
=== Getting a reference to the solar plant definition ===<br />
<br />
Every unit in Spring has a UnitDef (a 'unit defintion'). This object tells you all there is to know about the properties of the unit type, such as maximum speed, turn rate and what weapons it carries.<br />
One way to get the reference to the definition of a solar plant is to use <code>callback.getUnitDefs()</code>. This will give you a list of all the available unit types in the game that is currently being played.<br />
The name of the unit def we are looking for is 'armsolar', so we can just iterate through the list and find the one named armsolar, like this:<br />
<br />
<code><pre><br />
List<UnitDef> unitDefs = this.callback.getUnitDefs();<br />
UnitDef solarPlant = null;<br />
for (UnitDef def : unitDefs)<br />
if (def.getName().equals("armsolar"))<br />
{<br />
solarPlant = def;<br />
break;<br />
}<br />
</pre></code><br />
<br />
<br />
=== Telling the commander to build the solar plant ===<br />
<br />
Now, the only thing left to do is to tell the commander that we want it to build the solar plant, and where to place it. In short, we need to give the commander a build command.<br />
<br />
We want to give this command only once at the first frame of the game. For this we can use the <code>update()</code> method, which is called at every frame of the game. All we need to do is overwrite the <code>update(int frame)</code> method and give the command if the frame is 1. This results in the following code:<br />
<br />
<code><pre><br />
@Override<br />
public int update(int frame)<br />
{<br />
if (frame == 0)<br />
{<br />
// give command here<br />
}<br />
<br />
return 0;<br />
}<br />
</pre></code><br />
<br />
Commands are issued by invoking the respective method on the <code>Unit</code> (or <code>Group</code>). In our case, that's the <code>build</code> method, which takes the following arguments:<br />
<br />
* <code>UnitDef toBuildUnitDef</code>: the kind of unit to build<br />
* <code>AIFLoat3 buildPos</code>: the location the unit should be built at (in our case, we use the commander's current position)<br />
* <code>int facing</code>: the direction the new unit will be facing (mostly matters for buildings, which can not turn after being constructed)<br />
* <code>short options</code>: a set of UnitCommandOptions. 0 means no option.<br />
* <code>int timeout</code>: the number of frames after which the command times out. We don't want a timeout, and therefore specify a suitably high number :-)<br />
<br />
Therefore, our command looks like this:<br />
<br />
<code><br />
commander.build(solarDef, commander.getPos(), 0, (short) 0, Integer.MAX_VALUE);<br />
</code><br />
<br />
At this point you will want to see if your AI actually works. Export your code to ''Spring/AI/Skirmish/MyJavaAI/SkirmishAI.jar'' and start up a game. Your AI should now build a solar plant at its start position.<br />
<br />
===Building a metal extractor===<br />
Building a metal extractor is slightly more complicated. Assuming you're not on a metal map, you will need to find a suitable site to place the extractor. Generally, it's preferable to select a site closest to wherever your construction unit (commander) is located.<br />
<br />
Modify your code that got a reference to the solar plant by making the following changes:<br />
<br />
<code><pre><br />
List<UnitDef> unitDefs = this.callback.getUnitDefs(); UnitDef solarPlant = null; for (UnitDef def : unitDefs)<br />
<br />
if (def.getName().equals("armsolar"))<br />
{<br />
solarPlant = def;<br />
}<br />
else if (def.getName().equals("armmex"))<br />
{<br />
metalExtractor=def;<br />
}<br />
</pre></code><br />
<br />
Again, you will need to create a Unitdef metalExtractor field by where you declared your solarPlant field.<br />
<br />
Next, you need a method for determining the distance between two 3D coordinates (since Spring locations are three dimensional). A slightly modified version of a distance function is found below.<br />
<br />
<code><pre><br />
public float calculateDistance(AIFloat3 a, AIFloat3 b)<br />
{<br />
float xDistance = a.x - b.x;<br />
float yDistance = a.y - b.y;<br />
float zDistance = a.z - b.z;<br />
float totalDistanceSquared = xDistance*xDistance + yDistance*yDistance + zDistance*zDistance;<br />
return totalDistanceSquared;<br />
} <br />
</pre></code><br />
<br />
The above code actually returns the distance squared, but it will work for our purposes. In your init function, you will want to add the following code above the return statement but below the line defining the callback:<br />
<br />
<code><pre><br />
checkForMetal();<br />
</pre></code><br />
<br />
This will call the following function you need to place in your code:<br />
<br />
<code><pre><br />
public void checkForMetal()<br />
{<br />
Resource metal=Resource.getInstance(clb, 0);<br />
availablemetalspots=clb.getMap().getResourceMapSpotsPositions(metal);<br />
if(availablemetalspots.isEmpty())<br />
{<br />
sendTextMsg("This is a map with no metal spots");<br />
metalmap=false;<br />
}<br />
else<br />
{metalmap=true;<br />
sendTextMsg("This is a map with metal spots. Listing Values...");<br />
for (AIFloat3 metalspot : availablemetalspots) {<br />
sendTextMsg("Metal Spot at X: "+metalspot.x + ", Y: "+metalspot.y +", Z: "+metalspot.z);<br />
}<br />
}<br />
}<br />
</pre></code><br />
<br />
For the above code to function properly, you will need to create a Boolean named metalmap and a List<AIFloat3> availablemetalspots. You will now have a function set up for calculating distance between two points, and a data structure holding a list of positions of metal spots. The next step is to tie these two together:<br />
<br />
<code><pre><br />
public AIFloat3 closestMetalSpot(AIFloat3 unitposition)<br />
{<br />
AIFloat3 closestspot=null;<br />
for (AIFloat3 metalspot : availablemetalspots) {<br />
if (closestspot==null)<br />
{<br />
closestspot=metalspot;<br />
}<br />
else if(calculateDistance(metalspot, unitposition) < calculateDistance(closestspot, unitposition) && metalspot.hashCode()!=unitposition.hashCode())<br />
{<br />
closestspot=metalspot;<br />
}<br />
}<br />
availablemetalspots.remove(closestspot);<br />
return closestspot;<br />
<br />
}<br />
</pre></code><br />
<br />
The above function accepts an AIFloat3 containing the location of your construction unit (commander). It will then find the closest metal spot and return that location. The next step is to have your commander make use of this.<br />
<br />
<code><pre><br />
if (frame == 600)<br />
{<br />
if(metalmap){ sendTextMsg("About to build mex at frame " + frame);<br />
AIFloat3 closestspot=closestMetalSpot(commander.getPos());<br />
commander.build(metalExtractor, closestspot, 0, (short) 0, Integer.MAX_VALUE);<br />
}<br />
</pre></code><br />
<br />
Place the above code in your update() method. When the frame count reaches 600, your commander will start to build a metal extractor at the closest metal spot. The extractor may not be right on top of where the metal spot appears to be, but you can mouse over the extractor to make sure it's drawing the metal properly.<br />
<br />
== Frequently Asked Questions ==<br />
<br />
<br />
'''Q:''' What is the difference between <code>unitCreated()</code> and <code>unitFinished()</code>?<br />
<br />
'''A:''' The difference is that <code>unitCreated()</code> is called when construction of a unit starts, while <code>unitFinished()</code> when construction on the unit has been completed. Any number of things may happen in-between, including the unit under construction being destroyed, so it is important to remember this distinction.<br />
<br />
'''Q:''' Do I have to copy and paste my jar file to the directory in Spring/AI/Skirmish/MyAI/0.1 each time I want to test my AI out?<br />
<br />
'''A:''' Yes, but it is much easier if you automate the process. In Windows, a simple batch file can be created to move the files over for you. For example<br />
<br />
<code><pre><br />
copy C:\Users\msm8bball\Documents\NetBeansProjects\MyAI\dist\MyAI.jar "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1"<br />
<br />
del "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1\SkirmishAI.jar"<br />
rename "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1\MyAI.jar" SkirmishAI.jar<br />
</pre></code><br />
<br />
Modify the above code to match your computer's directories. Place it in a text file and save it as MoveAI.bat. This will create a batch file that you can double click and it will automatically move your AI to the proper location and rename it. You might wish to put a shortcut to this in your Start menu or taskbar. <br />
<br />
'''Q:''' I have problems with the class-loader in my AI, any idea? <br />
<br />
'''A:''' Each Java AI implementation is loaded by a separate class loader. This is used to load all the AI's class files and dependency libraries (in the ''jlib'' dir). Some libraries though, use the Thread contexts class loader, instead of the one of the current class. Therefore, if you want to load something from the AI's own class-path, make sure to let these libraries use the class-path of your AI classes, eg:<br />
<code><pre><br />
ClassLoader myClassLoader = AIFactory.class.getClassLoader();<br />
MySpecialUtil msp = new MySpecialUtil();<br />
msp.setClassLoader(myClassLoader);<br />
</pre></code><br />
Please do not set this class-loader on the thread with <code>Thread.currentThread().setContextClassLoader(myClassLoader)</code>, because all AI's are run in the same Java thread, and therefore this will cause problems.<br />
<br />
<br />
== Links ==<br />
* [[AIInterface:Java|Java AI Interface]]<br />
* [http://spring.abma.de/doc-Interface-JavaOO/ Javadoc of the Java AI OO Wrapper] (generated in 2014 from source by [[User:Abma|abma]], currently broken)<br />
* '''OUTDATED''' [http://springrts.com/phpbb/download/file.php?id=4970 Netbeans Java Skirmish AI Tutorial] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread])<br />
* [http://modinfo.adune.nl/index.php?MOD=ba712 ModInfo] (contains a list of units and their short names)<br />
<br />
[[Category: AI Dev]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Animation-LuaScripting&diff=2099Animation-LuaScripting2015-02-02T10:10:31Z<p>Anarchid: /* Workflow */</p>
<hr />
<div>== Getting started ==<br />
<br />
=== Setup ===<br />
<br />
Lua unit animation is implemented partially in the engine, and partially in a Lua gadget which is shipped with Spring in [[springcontent.sdz]]. By default, gadget is not loaded, so a bit of setup is required to enable Lua unit scripts. (In some games, gadget is alredy activated, for example in Zero:k)<br />
<br />
To enable Lua unit scripts, create a file ''LuaRules/Gadgets/unit_script.lua'', and paste the following into it:<br />
<br />
{|border="0" cellpadding="4"<br />
|style="background: #41545c; border: 1px #aaa solid;"|<br />
<small><br />
-- Enables Lua unit scripts by including the gadget from springcontent.sdz<br />
<br />
-- Uncomment to override the directory which is scanned for *.lua unit scripts.<br />
--UNITSCRIPT_DIR = "scripts/"<br />
<br />
return include("LuaGadgets/Gadgets/unit_script.lua")<br />
</small><br />
|}<br />
<br />
Also, do check whether your [http://github.com/spring/spring/blob/master/installer/builddata/springcontent/LuaGadgets/system.lua ''LuaRules/system.lua''] is up to date, if you copied this verbatim into your game. (Must be from a later date than 5 september 2009)<br />
<br />
Now this is done, you can start putting *.lua files in your ''scripts/'' folder.<br />
<br />
=== Workflow ===<br />
<br />
Lua has the major advantage over BOS/COB that you do not need to compile it, which can reduce the time to develop scripts quite a bit.<br />
<br />
To save further time, do not restart Spring for each small change. Simply run Spring in an window so you can easily switch between your editor and Spring, and use ''/cheat'' and ''/luarules reload'' to reload all Lua unit scripts.<br />
<br />
To be able to use commands above, unzip your game into directory named "myGame.sdd", then you can directly change lua scripts (animations etc.) and reload.<br />
<br />
Additionally, for Lua unit scripts operating on Assimp models (primarily .dae and .blend), it is possible to do most of your animating in Blender using the [https://github.com/Anarchid/blender2lus blender2lus] export addon.<br />
<br />
== Further reading ==<br />
* [http://tvo.github.com/spring/2010/04/19/lus-stumpy.html Stumpy tutorial]<br />
* [http://tvo.github.com/spring/2010/04/26/lus-stumpy-2.html Polishing the stumpy]<br />
* [[Animation-LuaCallins]]<br />
* [[Animation-LuaCallouts]]<br />
* [[Animation-CobLuaDifferences | comparing Lua and COB unit scripts]]<br />
* [[SpringTutorialGame]] contains simple examples unit scripts<br />
* [[SpringRtsTutorialAnimDef]] examples animation scripts<br />
<br />
== TODO ==<br />
<br />
* Conversion tool<br />
* Performance measurements<br />
* Link to article in piro's magazine<br />
* Coordinate system (axis, direction of rotation, picture)<br />
<br />
<br />
<br />
<br />
[[Category:Animation]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Animation-LuaScripting&diff=2098Animation-LuaScripting2015-02-02T10:09:40Z<p>Anarchid: /* Workflow */ added b2l reference</p>
<hr />
<div>== Getting started ==<br />
<br />
=== Setup ===<br />
<br />
Lua unit animation is implemented partially in the engine, and partially in a Lua gadget which is shipped with Spring in [[springcontent.sdz]]. By default, gadget is not loaded, so a bit of setup is required to enable Lua unit scripts. (In some games, gadget is alredy activated, for example in Zero:k)<br />
<br />
To enable Lua unit scripts, create a file ''LuaRules/Gadgets/unit_script.lua'', and paste the following into it:<br />
<br />
{|border="0" cellpadding="4"<br />
|style="background: #41545c; border: 1px #aaa solid;"|<br />
<small><br />
-- Enables Lua unit scripts by including the gadget from springcontent.sdz<br />
<br />
-- Uncomment to override the directory which is scanned for *.lua unit scripts.<br />
--UNITSCRIPT_DIR = "scripts/"<br />
<br />
return include("LuaGadgets/Gadgets/unit_script.lua")<br />
</small><br />
|}<br />
<br />
Also, do check whether your [http://github.com/spring/spring/blob/master/installer/builddata/springcontent/LuaGadgets/system.lua ''LuaRules/system.lua''] is up to date, if you copied this verbatim into your game. (Must be from a later date than 5 september 2009)<br />
<br />
Now this is done, you can start putting *.lua files in your ''scripts/'' folder.<br />
<br />
=== Workflow ===<br />
<br />
Lua has the major advantage over BOS/COB that you do not need to compile it, which can reduce the time to develop scripts quite a bit.<br />
<br />
To save further time, do not restart Spring for each small change. Simply run Spring in an window so you can easily switch between your editor and Spring, and use ''/cheat'' and ''/luarules reload'' to reload all Lua unit scripts.<br />
<br />
To be able to use commands above, unzip your game into directory named "myGame.sdd", then you can directly change lua scripts (animations etc.) and reload.<br />
<br />
Additionally, for Lua unit scripts operating on Assimp models (primarily .dae and .blend), it is possible to do most of your animating in Blender using the blender2lus[https://github.com/Anarchid/blender2lus] export addon.<br />
<br />
== Further reading ==<br />
* [http://tvo.github.com/spring/2010/04/19/lus-stumpy.html Stumpy tutorial]<br />
* [http://tvo.github.com/spring/2010/04/26/lus-stumpy-2.html Polishing the stumpy]<br />
* [[Animation-LuaCallins]]<br />
* [[Animation-LuaCallouts]]<br />
* [[Animation-CobLuaDifferences | comparing Lua and COB unit scripts]]<br />
* [[SpringTutorialGame]] contains simple examples unit scripts<br />
* [[SpringRtsTutorialAnimDef]] examples animation scripts<br />
<br />
== TODO ==<br />
<br />
* Conversion tool<br />
* Performance measurements<br />
* Link to article in piro's magazine<br />
* Coordinate system (axis, direction of rotation, picture)<br />
<br />
<br />
<br />
<br />
[[Category:Animation]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Gamedev:WeaponDefs&diff=8789Gamedev:WeaponDefs2014-12-15T19:12:56Z<p>Anarchid: /* Collision & Avoidance */ debunk collisionSize</p>
<hr />
<div>[[Gamedev:Main|Development]] < [[Gamedev:Main]] < {{FULLPAGENAME}}<br />
<br />
==Location==<br />
WeaponDef files are .lua files stored in the <code>Weapons/</code> directory of a Spring Game. Alternatively they can be integrated into [[Gamedev:UnitDefs|UnitDefs]].<br />
<br />
==Purpose==<br />
WeaponDef files have one purpose; to define the properties of weapons. They are the main description file for what attributes your weapon should have and how it should behave.<br />
<br />
==Source==<br />
The engine source code which loads the tags from these files is viewable here:<br />
<br />
* {{sourcelink|file=rts/Sim/Weapons/WeaponDef.cpp}}<br />
<br />
==Data Types==<br />
{{DataTypes}}<br />
<br />
==Details==<br />
There follows a comprehensive (certain deprecated tags are not present) list of the tags available, their data type, default value and a brief description of what they do. Bear in mind that the source code linked above is the ultimate reference when dealing with these tags. <br />
<br />
In lua tables keys (i.e. the tags) should be lower case, here they are represented in camelCase for readability. In your files you may use the <code>lowerkeys</code> function on your final table to ensure the keys are properly cased.<br />
<br />
It is usual to name the returned WeaponDef table the internal <code>weaponName</code> desired for the weapon.<br />
<br />
===Common===<br />
The following tags are common to all or at least a majority of '''WeaponTypes''', depending on the tag.<br />
<br />
====General====<br />
{{tag<br />
|name = weaponType<br />
|type = string<br />
|default = "Cannon"<br />
|description = Spring has 14 '''WeaponTypes''' which provide game developers with basic behaviours which they can customise to an extent with the '''WeaponDef''' tags. Some tags are specific to certain '''WeaponTypes''' and not implemented for others, [https://docs.google.com/spreadsheet/ccc?key=0Am5BbZxm93S9dEZXc1Q4dXR4TFRYTFM4NlR4OFJFdWc#gid=0 this two-way table] indicates which tags work for which types.}} The possible values are:<br />
* [[#AircraftBomb|AircraftBomb]]<br />
* [[#BeamLaser|BeamLaser]]<br />
* [[#Cannon|Cannon]]<br />
* [[#DGun|Dgun]]<br />
* [[#EmgCannon|EmgCannon]]<br />
* [[#Flame|Flame]]<br />
* [[#LaserCannon|LaserCannon]]<br />
* [[#LightningCannon|LightningCanon]]<br />
* [[#Melee|Melee]]<br />
* [[#MissileLauncher|MissileLauncher]]<br />
* [[#Rifle|Rifle]]<br />
* [[#Shield (WeaponType)|Shield]]<br />
* [[#StarburstLauncher|StarburstLauncher]]<br />
* [[#TorpedoLauncher|TorpedoLauncher]]<br />
<br />
{{tag<br />
|name = name<br />
|type = string<br />
|default = "Weapon"<br />
|description = The descriptive name of the weapon as listed in FPS mode.}}<br />
<br />
{{tag<br />
|name = turret<br />
|type = bool<br />
|default = false<br />
|description = Does the unit aim within an arc (up-to and including full 360° turret traverse) or always aim along the owner's heading?}}<br />
<br />
{{tag<br />
|name = noSelfDamage<br />
|type = bool<br />
|default = false<br />
|description = Can the weapon's explosion damage the unit which fires it? Useful for preventing bombers with high-yield weapons destroying themselves.}}<br />
<br />
{{tag<br />
|name = impactOnly<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon only deal damage through direct hits and not 'splash' damage through {{taglink|areaOfEffect}}?}}<br />
<br />
{{tag<br />
|name = noExplode<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon explode on impact with a target or continue through? Note that these weapons will do damage every single frame they are inside the [[Gamedev:CollisionVolumes|collision volume]] of an object, underground or under water, massively multiplying their damage.}}<br />
<br />
{{tag<br />
|name = burnblow<br />
|type = bool<br />
|default = false<br />
|special = lua: selfExplode<br />
|description = Does the weapon explode when it reaches its maximum range or continue on its path? The name is an [[OTAism]].}}<br />
<br />
{{tag<br />
|name = range<br />
|type = float<br />
|default = 10.0<br />
|description = The maximum range in [[elmo]]s that the weapon can fire at.}}<br />
<br />
{{tag<br />
|name = weaponVelocity<br />
|type = float<br />
|default = 0.0<br />
|description = The velocity in [[elmo]]s per second of the weapon projectile.}}<br />
<br />
{{tag<br />
|name = reloadTime<br />
|type = float<br />
|default = 1.0<br />
|description = The time in seconds between shots fired.}}<br />
<br />
{{tag<br />
|name = metalPerShot<br />
|type = float<br />
|default = 0.0<br />
|description = 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 {{taglink|stockpile}} weapon will cost to build.}}<br />
<br />
{{tag<br />
|name = energyPerShot<br />
|type = float<br />
|default = 0.0<br />
|description = Energy used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a {{taglink|stockpile}} weapon will cost to build.}}<br />
<br />
{{tag<br />
|name = myGravity<br />
|type = float<br />
|default = 0.0<br />
|description = Overrides the map gravity for ballistic weapons. The default of <code>0.0</code> disables the tag in favour of map gravity.}}<br />
<br />
{{tag<br />
|name = fireStarter<br />
|type = float<br />
|default = 0.0<br />
|description = The percentage chance (<code>0.0</code> to <code>100.0</code>) of the weapon setting fire to static map features on impact.}}<br />
<br />
{{tag<br />
|name = cameraShake<br />
|type = float<br />
|default = damage (0.0 for paralyzers)<br />
|description = Passed to the [[LuaCallinReturn#Game_Events:|ShockFront() callin]] as the first argument. Intended as a means to make the camera shake if in range of detonation.}}<br />
<br />
{{tag<br />
|name = stockpile<br />
|type = bool<br />
|default = false<br />
|description = Does each round of the weapon have to be built and stockpiled by the player? Will only correctly function for the first of each stockpiled weapons a unit has.}}<br />
<br />
{{tag<br />
|name = stockpileTime<br />
|type = float<br />
|default = reloadTime<br />
|description = The time in seconds taken to stockpile one round of the weapon.}}<br />
<br />
{{tag<br />
|name = interceptedByShieldType<br />
|type = int<br />
|default = 0 (See description)<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of shields that can intercept this weapon. Each digit of binary that is set to one means that a shield with the corresponding digit in its {{taglink|interceptType}} will intercept this weapon. The defaults are as follows:<br />
* <code>1</code> - [[#Cannon]] and [[#EmgCannon]]<br />
* <code>2</code> - [[#LaserCannon]] and [[#BeamLaser]]<br />
* <code>4</code> - [[#MissileLauncher]] and [[#StarburstLauncher]]<br />
* <code>8</code> - [[#AircraftBomb]]<br />
* <code>16</code> - [[#Flame]]<br />
* <code>32</code> - [[#TorpedoLauncher]]<br />
* <code>64</code> - [[#LightningCannon]]<br />
* <code>128</code> - [[#Rifle]]<br />
* <code>256</code> - [[#Melee]]<br />
(See [[Shield Interception Tag Use]]).}}<br />
<br />
====Collision & Avoidance====<br />
<br />
{{tag<br />
|name = avoidGround<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if terrain blocks the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidFriendly<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if a friendly unit is in the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidFeature<br />
|type = bool<br />
|default = true<br />
|description = Should the weapon avoid firing if a static map feature is in the line of fire?}}<br />
<br />
{{tag<br />
|name = avoidNeutral<br />
|type = bool<br />
|default = false<br />
|description = Should the weapon avoid firing if a neutral unit is in the line of fire?}}<br />
<br />
{{tag<br />
|name = collideEnemy<br />
|type = bool<br />
|default = true<br />
|special = lua: noEnemyCollide<br />
|description = Does the weapon projectile collide with enemy units or pass through?}}<br />
<br />
{{tag<br />
|name = collideFriendly<br />
|type = bool<br />
|default = true<br />
|special = lua: noFriendlyCollide<br />
|description = Does the weapon projectile collide with friendly units or pass through?}}<br />
<br />
{{tag<br />
|name = collideFeature<br />
|type = bool<br />
|default = true<br />
|special = lua: noFeatureCollide<br />
|description = Does the weapon projectile collide with static map features or pass through?}}<br />
<br />
{{tag<br />
|name = collideNeutral<br />
|type = bool<br />
|default = true<br />
|special = lua: noNeutralCollide<br />
|description = Does the weapon projectile collide with neutral units or pass through?}}<br />
<br />
{{tag<br />
|name = collideGround<br />
|type = bool<br />
|default = true<br />
|special = lua: noGroundCollide<br />
|description = Does the weapon projectile collide with terrain or pass through?}}<br />
<br />
{{tag<br />
|name = collisionSize<br />
|type = float<br />
|default = 0.05 (0.5 for [[#Flame]] and [[#LaserCannon]], 10.0 for [[#Dgun]])<br />
|description = The radius used in collision calculations. For <strike>non-instant-hit</strike> [https://github.com/spring/spring/blob/3034e5f5a8f5b9fb4624a97f7a85cb5c90457725/rts/Sim/Projectiles/WeaponProjectiles/WeaponProjectile.cpp#L250 hitscan] weapons which do not use a 3D {{taglink|model}}.}}<br />
<br />
====Targeting & Accuracy====<br />
{{tag<br />
|name = commandFire<br />
|type = bool<br />
|default = false<br />
|description = Determines if the weapon will automatically fire on enemy units in range or only when manually ordered to attack.}}<br />
<br />
{{tag<br />
|name = canAttackGround<br />
|type = bool<br />
|default = true<br />
|description = Determines if the weapon can be force-fired on ground positions or only fire on targeted units.}}<br />
<br />
{{tag<br />
|name = waterWeapon<br />
|type = bool<br />
|default = false<br />
|description = Determines if the weapon can pass through water and target underwater units.}}<br />
<br />
{{tag<br />
|name = fireSubmersed<br />
|type = bool<br />
|default = waterWeapon<br />
|description = Determines if the weapon can fire whilst underwater.}}<br />
<br />
{{tag<br />
|name = targetBorder<br />
|type = float<br />
|default = 0.0 (1.0 for [[#Melee]])<br />
|description = Controls whether the weapon aims for the centre or the edge of its target's [[Gamedev:CollisionVolumes|collision volume]]. Clamped between <code>-1.0</code> - target the far border, and <code>1.0</code> - target the near border.}}<br />
<br />
{{tag<br />
|name = cylinderTargeting<br />
|type = float<br />
|default = 0.0 (1.0 for [[#Melee]])<br />
|description = Controls whether the weapon range is calculated in a sphere or a cylinder. The height of the cylinder is determined by the value of this tag multiplied by the {{taglink|range}}. Clamped between <code>0.0</code> and <code>128.0</code>.}}<br />
<br />
{{tag<br />
|name = tolerance<br />
|type = float<br />
|default = 3000.0<br />
|description = 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. For {{taglink|turret|false}} or {{taglink|fixedLauncher|true}} weapons this determines in what arc the unit will fire.}}<br />
<br />
{{tag<br />
|name = targetMoveError<br />
|type = float<br />
|default = 0.0<br />
|description = 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.}}<br />
<br />
{{tag<br />
|name = leadLimit<br />
|type = float<br />
|default = -1.0<br />
|description = Limits the maximum distance a unit will lead a target. The default of <code>-1</code> allows an infinite distance.}}<br />
<br />
{{tag<br />
|name = leadBonus<br />
|type = float<br />
|default = 0.0<br />
|description = Controls how experience boosts the weapon's target leading. Is multiplied with the unit's experience and added to the {{taglink|leadLimit}}.}}<br />
<br />
{{tag<br />
|name = predictBoost<br />
|type = float<br />
|default = 0.0 (0.5 for {{taglink|burnblow|true}} weapons)<br />
|description = Controls how well the weapon predicts unit speeds. Works in a similar way to {{taglink|targetMoveError}} except that it is 1-dimensional. This tag spreads the shots in a line based on the direction of the target whereas {{taglink|targetMoveError}} spreads the shots all around based on the movement.}}<br />
<br />
{{tag<br />
|name = heightMod<br />
|type = float<br />
|default = 0.2 (0.8 for [[#Cannon]], 1.0 for [[#BeamLaser]] and [[#LightningCannon]])<br />
|description = Changes the spherical weapon range into an ellipsoid. Values above <code>1.0</code> mean the weapon cannot target as high as it can far, values below <code>1.0</code> mean it can target higher than it can far. For example <code>0.5</code> would allow the weapon to target twice as high as far.}}<br />
<br />
{{tag<br />
|name = proximityPriority<br />
|type = float<br />
|default = 1.0<br />
|description = Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets.}}<br />
<br />
{{tag<br />
|name = accuracy<br />
|type = float<br />
|default = 0.0<br />
|description = How accurate the weapon is. Lower values are more accurate. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high value will probably still hit. If a target is very far away, even a very low value will likely cause the weapon to miss.}}<br />
<br />
{{tag<br />
|name = movingAccuracy<br />
|type = float<br />
|default = accuracy<br />
|description = A weapon's {{taglink|accuracy}} whilst the owning unit is moving.}}<br />
<br />
{{tag<br />
|name = sprayAngle<br />
|type = float<br />
|default = 0.0<br />
|description = How wide the the angle of a burst from a [[#Bursts|burst weapon]] can be. Very similar to {{taglink|accuracy}}, except that this tag affects each projectile in a burst, whilst the former does not.}}<br />
<br />
{{tag<br />
|name = ownerExpAccWeight<br />
|type = float<br />
|default = 0.0 (See description)<br />
|description = A multiplier to {{taglink|accuracy}} and {{taglink|sprayAngle}} that reduces inaccuracy as a units experience increases. Defaults are as follows:<br />
* <code>0.9</code> - [[#Cannon]], [[#Rifle]]<br />
* <code>0.7</code> - [[#LaserCannon]], [[#BeamLaser]], [[#StarburstLauncher]]<br />
* <code>0.5</code> - [[#MissileLauncher]], [[#LightningCannon]], [[#EmgCannon]], [[#DGun]]<br />
* <code>0.2</code> - [[#Flame]]<br />
}}<br />
<br />
{{tag<br />
|name = targetable<br />
|type = int<br />
|default = 0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapon that can intercept this weapon. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptor}} tag will intercept this weapon. Instant-hitting weapons such as [[#BeamLaser]], [[#LightningCannon]] and [[#Rifle]] cannot be targeted.<br />
}}<br />
<br />
{{tag<br />
|name = interceptor<br />
|type = int<br />
|default = 0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this weapon can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|targetable}} tag will be intercepted by this weapon.<br />
}}<br />
<br />
{{tag<br />
|name = interceptSolo<br />
|type = bool<br />
|default = true<br />
|special = {{new|92.0}} <br />
|description = If <code>true</code> no other interceptors may target the same projectile.<br />
}}<br />
<br />
{{tag<br />
|name = coverage<br />
|type = float<br />
|default = 0.0<br />
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]<br />
|description = The radius in [[elmo]]s within which an {{taglink|interceptor}} weapon will fire on {{taglink|targetable}} weapons.<br />
}}<br />
<br />
====Bouncing====<br />
<br />
{{tag<br />
|name = waterBounce<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon bounce on water impacts?}}<br />
<br />
{{tag<br />
|name = groundBounce<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon bounce on ground impacts?}}<br />
<br />
{{tag<br />
|name = bounceSlip<br />
|type = float<br />
|default = 1.0<br />
|description = The decimal-percentage amount of horizontal velocity a projectile keeps when it bounces.}}<br />
<br />
{{tag<br />
|name = bounceRebound<br />
|type = float<br />
|default = 1.0<br />
|description = The decimal-percentage amount of vertical velocity a projectile keeps when it bounces.}}<br />
<br />
{{tag<br />
|name = numBounce<br />
|type = int<br />
|default = -1<br />
|description = The number of times the weapon will bounce on impact before exploding. The default value of <code>-1</code> allows infinite bounces (at least until velocity reaches 0).}}<br />
<br />
====Area Of Effect, Impulse & Cratering====<br />
<br />
{{tag<br />
|name = areaOfEffect<br />
|type = float<br />
|default = 8.0 * 0.5<br />
|special = lua: damageAreaOfEffect<br />
|description = The ''diameter'' in [[elmo]]s in which the weapons explosion will cause damage.}}<br />
<br />
{{tag<br />
|name = craterAreaOfEffect<br />
|type = float<br />
|default = areaOfEffect * 0.5<br />
|description = The ''radius'' in [[elmo]]s in which the weapons explosion will cause terrain cratering. Behaviour changed slightly in 98.0 as previously craters were 1.5x {{taglink|craterAreaOfEffect}} whilst decals were 1.0x, they are now both the same size.}}<br />
<br />
{{tag<br />
|name = edgeEffectiveness<br />
|type = float<br />
|default = 0.0<br />
|description = Determines what percent of a weapon's maximum damage value will be applied to units within the weapon's {{taglink|areaOfEffect}}. Falls off from the epicentre according to the formula <code>damageApplied = damage * [(areaOfEffect - distToUnit) / (areaOfEffect - (distToUnit * edgeEffectiveness))]</code>, a graph of the function for various values is available [[Media:EdgeEffectiveness.png|here]].}}<br />
<br />
{{tag<br />
|name = explosionSpeed<br />
|type = float<br />
|default = See description<br />
|description = The speed at which the weapon's explosion propagates from the epicentre. The default is calculated by this complex formula: <code>defExpSpeed = {8.0 + [max(30.0, default_damage / 20.0) * 2.5]} / {9.0f + [sqrt(max(30.0, default_damage / 20.0f)) * 0.7]} * 0.5</code>.}}<br />
<br />
{{tag<br />
|name = impulseFactor<br />
|type = float<br />
|default = 1.0<br />
|description = A multiplier to the impulse given to units within the explosion {{taglink|areaOfEffect}}, which is otherwise equal to the damage dealt after {{taglink|edgeEffectiveness}} is taken into account. For [[#Melee]] weapons this is instead multiplied by the owning unit's mass (See [[Gamedev:UnitDefs#Tag:mass|Gamedev:UnitDefs]]).}}<br />
<br />
{{tag<br />
|name = impulseBoost<br />
|type = float<br />
|default = 0.0<br />
|description = A constant amount added to the weapon's impulse, regardless of distance from the epicentre or the damage potential of the explosion, prior to the application of {{taglink|impulseFactor}}}}<br />
<br />
{{tag<br />
|name = craterMult<br />
|type = float<br />
|default = impulseFactor<br />
|description = A multiplier to depth of terrain crater the weapon's explosion will create, which is otherwise based on the damage potential.}}<br />
<br />
{{tag<br />
|name = craterBoost<br />
|type = float<br />
|default = 0.0<br />
|description = A constant amount, added to the weapon's cratering depth before the application of {{taglink|craterMult}}.}}<br />
<br />
====Bursts====<br />
<br />
{{tag<br />
|name = burst<br />
|type = int<br />
|default = 1<br />
|special = lua: salvoSize<br />
|description = How many shots to fire per burst.<br />
}}<br />
<br />
{{tag<br />
|name = burstRate<br />
|type = float<br />
|default = 0.1<br />
|special = lua: salvoDelay<br />
|description = The time in seconds between shots in a burst. Note that {{taglink|reloadTime}} starts to count down from the ''first'' round fired, not the last so if <code>reloadTime < burst * burstRate</code> the weapon will fire continuously.<br />
}}<br />
<br />
{{tag<br />
|name = projectiles<br />
|type = int<br />
|default = 1<br />
|description = How many projectiles released per shot (shotgun style). e.g. a weapon with {{taglink|burst|5}}, {{taglink|burstRate|0.5}} and {{taglink|projectiles|2}} will shoot 5 lots of 2 for 10 projectiles total, with gaps of 0.5 seconds, before waiting for {{taglink|reloadTime}}. Best used in conjunction with {{taglink|sprayAngle}} or changing the firing piece using [[Animation-LuaCallins#Weapons|ShotX]] as otherwise they'll all be clumped in one shot.<br />
}}<br />
<br />
====Paralyzing====<br />
{{tag<br />
|name = paralyzer<br />
|type = bool<br />
|default = false<br />
|description = Is the weapon a paralyzer? If <code>true</code> the weapon only stuns enemy units and does not cause damage in the form of lost hit-points.<br />
}}<br />
<br />
{{tag<br />
|name = paralyzeTime<br />
|type = int<br />
|default = 10<br />
|special = lua: damages.paralyzeDamageTime<br />
|description = Determines the maximum length of time in seconds that the target will be paralyzed. The timer is restarted every time the target is hit by the weapon. Cannot be less than <code>0</code>.<br />
}}<br />
<br />
====Dynamic Damage====<br />
The following set of tags allow for a weapon's damage potential to vary with the distance to its target.<br />
<br />
{{tag<br />
|name = dynDamageExp<br />
|type = float<br />
|default = 0.0<br />
|description = Exponent of the range-dependent damage formula, the default of <code>0.0</code> disables dynamic damage, <code>1.0</code> means linear scaling, <code>2.0</code> quadratic and so on.<br />
}}<br />
<br />
{{tag<br />
|name = dynDamageMin<br />
|type = float<br />
|default = 0.0<br />
|description = The minimum floor value that range-dependent damage can drop to.<br />
}}<br />
<br />
{{tag<br />
|name = dynDamageRange<br />
|type = float<br />
|default = 0.0<br />
|description = If set to non-zero values the weapon will use this value in the range-dependant damage formula instead of the actual {{taglink|range}}. <br />
}}<br />
<br />
{{tag<br />
|name = dynDamageInverted<br />
|type = bool<br />
|default = false<br />
|description = If <code>true</code> the damage curve is inverted i.e. the weapon does more damage at greater ranges as opposed to less.<br />
}}<br />
<br />
====Sounds====<br />
{{tag<br />
|name = soundTrigger<br />
|type = bool<br />
|default = false (true for [[#Melee]], [[#Rifle]] and non-beamBurst [[#BeamLaser]])<br />
|description = Does the weapon play {{taglink|soundStart}} for every round in a burst (<code>true</code>) or only once for each salvo (<code>false</code>)?}}<br />
<br />
{{tag<br />
|name = soundStart<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon fires.}}<br />
<br />
{{tag<br />
|name = soundHitDry<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with solid ground. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}<br />
<br />
{{tag<br />
|name = soundHitWet<br />
|type = string<br />
|default = ""<br />
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with water. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}<br />
<br />
====Visuals====<br />
<br />
{{tag<br />
|name = cegTag<br />
|type = string<br />
|default = ""<br />
|description = The name, without prefixes, of a [[CEG]] to be emitted by the projectile each frame.<br />
}}<br />
<br />
{{tag<br />
|name = intensity<br />
|type = float<br />
|default = 0.9 (0.2 for [[#Cannon]])<br />
|description = Alpha transparency for non-3D model projectiles. Lower values are more opaque, but <code>0.0</code> will cause the projectile to disappear entirely.<br />
}}<br />
<br />
{{tag<br />
|name = model<br />
|type = string<br />
|default = ""<br />
|description = The filename of a 3D model to use when rendering the projectile. Note that only the root piece of a projectile model is rendered. Currently only for [[#Cannon]], [[#LaserCannon]], [[#MissileLauncher]], [[#StarburstLauncher]] and [[#TorpedoLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = explosionScar<br />
|type = bool<br />
|default = false<br />
|description = Does the weapon's explosion leave a scar decal on the ground? For all types except [[#Melee]] and [[#Rifle]].<br />
}}<br />
<br />
{{tag<br />
|name = alwaysVisible<br />
|type = bool<br />
|default = false<br />
|description = If <code>true</code> the weapon is always rendered regardless of whether or not it is in LOS range of a player's units.<br />
}}<br />
<br />
{{tag<br />
|name = rgbColor<br />
|type = float[3]<br />
|default = {1.0, 0.0, 0.0} (See Description)<br />
|description = The primary colour for sprite rendering weapons. Additional defaults are as follows:<br />
* [[#Cannon]] - <code>{1.0, 0.5, 0.0}</code><br />
* [[#EmgCannon]] - <code>{0.9, 0.9, 0.2}</code><br />
}}<br />
<br />
{{tag<br />
|name = explosionGenerator<br />
|type = string<br />
|default = ""<br />
|description = The name of a [[CEG]], with <code>custom:</code> prefix, to spawn as the weapon's explosion. Does not currently work for [[#Melee]] and [[#Rifle]].<br />
}}<br />
<br />
{{tag<br />
|name = bounceExplosionGenerator<br />
|type = string<br />
|default = ""<br />
|description = For weapons which can use {{taglink|groundBounce|true}}, the name of a [[CEG]], with <code>custom:</code> prefix, to spawn when weapon the bounces.<br />
}}<br />
<br />
{{tag<br />
|name = texture1<br />
|type = string<br />
|default = ""<br />
|description = The projectile texture for [[#AircraftBomb]], [[#Cannon]], [[#EmgCannon]], [[#Flame]]; beam texture for [[#LaserCannon]], [[#BeamLaser]], [[#LightningCannon]]; flare texture for [[#MissileLauncher]], [[#StarburstLauncher]] and dome texture for the [[#Shield]].<br />
}}<br />
<br />
{{tag<br />
|name = texture2<br />
|type = string<br />
|default = ""<br />
|description = The end-of-beam texture for [[#LaserCannon]], [[#BeamLaser]] and {{taglink|smoketrail}} texture for [[#MissileLauncher]], [[#StarburstLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = texture3<br />
|type = string<br />
|default = ""<br />
|description = Flare texture for [[#BeamLaser]], or muzzle texture if {{taglink|largeBeamLaser|true}}. Also used as the flame texture for [[#StarburstLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = texture4<br />
|type = string<br />
|default = ""<br />
|description = Flare texture for [[#BeamLaser]] with {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
===AircraftBomb===<br />
Drops a ballistic projectile at the same movement vector as the unit itself. Intended only for aircraft. Visually drawn as a billboarded sprite as used by the [[#Cannon]], but more commonly used with a 3D model.<br />
<br />
There are no tags specific to this '''WeaponType'''<br />
<br />
====AircraftBomb Visuals====<br />
<br />
When not using a {{taglink|model}}, the AircraftBomb is the same as [[#Cannon Visuals]].<br />
<br />
===BeamLaser===<br />
An instant-hit weapon which spawns a beam and does a portion of its total damage each frame. Cannot be [[Animation-LuaCallouts#Effects|script emitted]] if it has a {{taglink|beamTime}} longer than one frame. Visually drawn as a [http://en.wikipedia.org/wiki/Star_Trek Star Trek] Phaser-style laser weapon. The {{taglink|largeBeamLaser}} tag allows changing the visual effect of the laser, such as using a tileable, scrolling texture without changing the behaviour.<br />
<br />
{{tag<br />
|name = minIntensity<br />
|type = float<br />
|default = 0.0<br />
|description = The minimum percentage the weapon's damage can fall-off to over its range. Setting to <code>1.0</code> will disable fall off entirely. Unrelated to the visual-only {{taglink|intensity}} tag.<br />
}}<br />
<br />
{{tag<br />
|name = beamTime<br />
|type = float<br />
|default = 1.0<br />
|description = How long in seconds to fire the laser before waiting for {{taglink|reloadTime}} to start. Damage is distributed over the duration of the {{taglink|beamTime}}, and the weapon will aim to hit the target when the beam is in the middle of its {{taglink|beamTime}} (i.e. using prediction).<br />
}}<br />
<br />
{{tag<br />
|name = beamBurst<br />
|type = bool<br />
|default = false<br />
|description = Makes the laser fire a burst of beams that are all aimed towards the target (instead of aimed with the piece). A [[#BeamLaser]] can do its full damage with every shot if {{taglink|beamBurst}} is enabled. Disables {{taglink|beamTime}} in favour of the [[#Bursts|burst tags]].<br />
}}<br />
<br />
{{tag<br />
|name = sweepFire<br />
|type = bool<br />
|default = false<br />
|description = Makes the laser continue firing while it aims for a new target, 'sweeping' across the terrain. Reimplemented in 95.0, still has no script interaction so use with care. Respects {{taglink|reloadTime}} constraint but not much else.<br />
}}<br />
<br />
====BeamLaser Visuals====<br />
<br />
See also {{taglink|thickness}} and {{taglink|coreThickness}}.<br />
<br />
{{tag<br />
|name = beamTTL<br />
|type = int<br />
|default = 0<br />
|description = The time in frames for which the laser beam remains visible.<br />
}}<br />
<br />
{{tag<br />
|name = beamDecay<br />
|type = float<br />
|default = 1.0<br />
|description = How fast the beam fades out. Each frame the {{taglink|intensity}} is multiplied by this value.<br />
}}<br />
<br />
{{tag<br />
|name = laserFlareSize<br />
|type = float<br />
|default = 15.0<br />
|description = Determines the size of the firing flare.<br />
}}<br />
<br />
{{tag<br />
|name = largeBeamLaser<br />
|type = bool<br />
|default = false<br />
|description = Changes the visual effect allowing tiling and scrolling of the texture and a pulsating firing flare.<br />
}}<br />
<br />
{{tag<br />
|name = tileLength<br />
|type = float<br />
|default = 200.0<br />
|description = Defines the length before the texture used is repeated (tiled). Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
{{tag<br />
|name = scrollSpeed<br />
|type = float<br />
|default = 5.0<br />
|description = Controls how fast the texture scrolls. Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
{{tag<br />
|name = pulseSpeed<br />
|type = float<br />
|default = 1.0<br />
|description = Controls how fast the pulsating effect at the start of the beam is. Only if {{taglink|largeBeamLaser|true}}.<br />
}}<br />
<br />
===Cannon===<br />
The default '''WeaponType'''. Fires a ballistic projectile, for the best result (without under/overshooting) the {{taglink|weaponVelocity}} should be set so as to give an elevation of 45° when firing at the maximum {{taglink|range}}. Substituting the angle into the [http://en.wikipedia.org/wiki/Trajectory#Range_and_height trajectory equation] and rearranging, we get: <br />
<code><pre>weaponVelocity = √(range * g)</pre></code> <br />
where <code>g</code> is the map gravity, usually around <code>120</code> for most Spring maps (You can use the {{taglink|myGravity}} tag if you want to be exact). Visually drawn as a billboarded sprite or 3D model. <br />
<br />
{{tag<br />
|name = highTrajectory<br />
|type = int<br />
|default = 2<br />
|description = Can this weapon be fired in a high trajectory (>45° angle). Can be <code>0</code> - low trajectory only, <code>1</code> - high trajectory only or <code>2</code> - enables a high/low toggle button on the unit.<br />
}}<br />
<br />
{{tag<br />
|name = heightBoostFactor<br />
|type = float<br />
|default = -1.0<br />
|description = Controls the boost given to {{taglink|range}} by high terrain. Values > <code>1.0</code> result in increased range, <code>0.0</code> means the cannon has fixed range regardless of height difference to target. Any value < <code>0.0</code> (i.e. the default value) result in an automatically calculated value based on {{taglink|range}} and theoretical maximum range.<br />
}}<br />
<br />
====Cannon Visuals====<br />
<br />
{{tag<br />
|name = size<br />
|type = float<br />
|default = 2.0 + min(default_damage * 0.0025, {{taglink|areaOfEffect}} * 0.1)<br />
|description = The drawing radius of the billboarded sprite. Also for [[#AircraftBomb Visuals]], [[#EmgCannon Visuals]] (default: <code>3.0</code>) and [[#Flame Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = colorMap<br />
|type = string<br />
|default = ""<br />
|description = A set of RGB colours to transition between over the projectile's lifetime. Can be given as a string of RGB digits or an image filename (See [[CColorMap]]). Also for [[#Flame Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = sizeDecay<br />
|type = float<br />
|default = 0.0<br />
|description = How quickly each particle of the Cannon shot decays in size.<br />
}}<br />
<br />
{{tag<br />
|name = alphaDecay<br />
|type = float<br />
|default = 1.0<br />
|description = How quickly each particle of the Cannon shot fades out.<br />
}}<br />
<br />
{{tag<br />
|name = separation<br />
|type = float<br />
|default = 0.0<br />
|description = The distance between each particle of the Cannon shot.<br />
}}<br />
<br />
{{tag<br />
|name = noGap<br />
|type = bool<br />
|default = true<br />
|description = Switch between the distance between particles being proportional to the size of the two particles (<code>true</code>) or proportional to the size of the first particle (<code>false</code>). <br />
}}<br />
<br />
{{tag<br />
|name = stages<br />
|type = int<br />
|default = 5<br />
|description = The number of particles in each Cannon shot.<br />
}}<br />
<br />
===DGun===<br />
Fires a line-of-sight or ballistic projectile (selected via the {{taglink|gravityAffected}} tag). Visually represented by a fireball effect that cannot be customised, however it can be replaced by a 3D model. The name and visual effect are [[OTAism]]s.<br />
<br />
{{tag<br />
|name = gravityAffected<br />
|type = bool<br />
|default = false<br />
|description = Does the fireball projectile lose height due to map gravity?<br />
}}<br />
<br />
===EmgCannon===<br />
A line-of-sight weapon. Visually drawn as a billboarded sprite very similar to that of the [[#Cannon]], however not as customisable, or a 3D model. The name is another [[OTAism]].<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Flame===<br />
A line-of-sight weapon intended for use as a flamethrower or similar. Visually drawn as a stream of textured particles, the colour of which can be controlled very precisely using the {{taglink|colorMap}} tag (see [[CColorMap]]).<br />
<br />
====Flame Visuals====<br />
See also {{taglink|colorMap}}.<br />
<br />
{{tag<br />
|name = sizeGrowth<br />
|type = float<br />
|default = 0.5<br />
|description = How much the draw radius of the flame projectile increases each frame.<br />
}}<br />
<br />
{{tag<br />
|name = flameGFXTime<br />
|type = float<br />
|default = 1.2<br />
|description = Makes the flamethrower projectile stay alive as a visual-only effect (i.e. does not deal any damage) after it has reached maximum {{taglink|range}}. It is a percentage multiplier, e.g. <code>1.2</code> makes the projectile stay alive until it reaches 20% beyond {{taglink|range}}.<br />
}}<br />
<br />
===LaserCannon===<br />
A particularly versatile line-of-sight weapon. Visually drawn like a [http://en.wikipedia.org/wiki/Star_Wars Star Wars] Blaster-style laser weapon, or a 3D model.<br />
<br />
====LaserCannon Visuals====<br />
<br />
{{tag<br />
|name = duration<br />
|type = float<br />
|default = 0.05<br />
|description = Multiplied against {{taglink|weaponVelocity}} to determine the visual length of the beam projectile.<br />
}}<br />
<br />
{{tag<br />
|name = hardStop<br />
|type = bool<br />
|default = false<br />
|description = Does the laser projectile stop dead or fade out?<br />
}}<br />
<br />
{{tag<br />
|name = fallOffRate<br />
|type = float<br />
|default = 0.5<br />
|description = Rate at which the beam fades out after it goes past its maximum {{taglink|range}} if {{taglink|hardStop|false}}. A value of <code>0.0</code> is never fade out, <code>1.0</code> is finish fading out exactly at maximum {{taglink|range}}.<br />
}}<br />
<br />
{{tag<br />
|name = lodDistance<br />
|type = int<br />
|default = 1000<br />
|description = Minimum camera distance at which the default LaserCannon projectile is simplified to a single rectangle.<br />
}}<br />
<br />
{{tag<br />
|name = thickness<br />
|type = float<br />
|default = 2.0<br />
|description = The thickness (width) of the LaserCannon projectile. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = coreThickness<br />
|type = float<br />
|default = 2.0<br />
|description = The thickness (width) of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
{{tag<br />
|name = rgbColor2<br />
|type = float<br />
|default = {1.0, 1.0, 1.0}<br />
|description = The colour of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].<br />
}}<br />
<br />
===LightningCannon===<br />
An instant-hit weapon similar to the [[#BeamLaser]], but which does all its damage at once. Visually drawn like [http://en.wikipedia.org/wiki/Star_Wars Star Wars] 'Force Lightning' or [http://en.wikipedia.org/wiki/Command_%26_Conquer:_Red_Alert CnC: Red Alert] [http://en.wikipedia.org/wiki/Tesla_coil Tesla Coil] weapons, the effect is not very customisable.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Melee===<br />
A weapon that always damages the target, no ifs or buts; unsurprisingly intended for use as a close quarters [http://en.wikipedia.org/wiki/Melee#Use_in_gaming 'melee'] weapon. It does not fire a projectile and does not care about the line of fire.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===MissileLauncher===<br />
A versatile weapon which can optionally track targets and accelerate from a low initial velocity. It can also use {{taglink|trajectoryHeight}} to have the shot arc similar to a ballistic projectile. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.<br />
<br />
{{tag<br />
|name = startVelocity<br />
|type = float<br />
|default = 0.0<br />
|description = The initial velocity of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].<br />
}}<br />
<br />
{{tag<br />
|name = acceleration<br />
|type = float<br />
|default = 0.0<br />
|description = The initial acceleration of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Note that if it is <code>0.0</code> the weapon can never increase from its {{taglink|startVelocity}} and will not reach its maximum {{taglink|weaponVelocity}}.<br />
}}<br />
<br />
{{tag<br />
|name = tracks<br />
|type = bool<br />
|default = false<br />
|description = Can the weapon projectile track a moving target? Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].}}<br />
<br />
{{tag<br />
|name = turnRate<br />
|type = float<br />
|default = 0.0<br />
|description = The rate (in [[Elmo#Angular|cau]]) at which {{taglink|tracks|true}} weapons turn towards their target. This is relative to a projectile's current velocity; a weapon with a higher velocity will need a higher value in order to be able to hit targets that turn suddenly.}}<br />
<br />
{{tag<br />
|name = flightTime<br />
|type = float<br />
|default = 0.0<br />
|description = The time in seconds before a missile projectile's fuel runs out; it ceases to obey {{taglink|tracks}}, loses velocity and falls to the ground. Also for [[#StarburstLauncher]]. Large values may cause over/undershoot problems.<br />
}}<br />
<br />
{{tag<br />
|name = fixedLauncher<br />
|type = bool<br />
|default = false<br />
|description = Makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Weapons may not correctly obey [[#Collision & Avoidance|avoidance settings]] when using this tag.<br />
}}<br />
<br />
{{tag<br />
|name = wobble<br />
|type = float<br />
|default = 0.0<br />
|description = Adds a random vector to the direction of travel every 16 frames, multiplied by the value of the tag. The effect is reduced as the firing unit gains experience. As this missiles direction is changed, wobbling swarm of missiles will diverge.<br />
}}<br />
<br />
{{tag<br />
|name = dance<br />
|type = float<br />
|default = 0.0<br />
|description = Adds a random vector to the position of a missile projectile every 8 frames, multiplied by the value of the tag. As the projectile is not rotated, a dancing swarm of missiles will remain relatively coherent.<br />
}}<br />
<br />
{{tag<br />
|name = trajectoryHeight<br />
|type = float<br />
|default = 0.0<br />
|description = Determines the height of the arc the missile will reach as it moves towards its target. A value of <code>0.0</code> will result in a flat trajectory, <code>1.0</code> will launch at 45&deg;. Can be any value >= <code>0.0</code>; extreme values may require the {{taglink|tracks}} tag to be able to hit a target.<br />
}}<br />
<br />
====MissileLauncher Visuals====<br />
A note about the missile exhaust flare: the size of the flare is determined by the model radius. The emit position of the flare is at (0,0,-radius) so the model may need careful adjustment to get the flare looking right.<br />
<br />
{{tag<br />
|name = smokeTrail<br />
|type = bool<br />
|default = false<br />
|description = Does the missile projectile emit a smoke trail as it travels? Also for [[#StarburstLauncher]].<br />
}}<br />
<br />
===Rifle===<br />
An instant hit weapon which does all its damage at once. Visually represented by a hardcoded tracer, firing and hitting effects. Rarely used.<br />
<br />
There are no tags specific to this '''WeaponType'''.<br />
<br />
===Shield (WeaponType)===<br />
As the name suggests, not a weapon but a defensive shield. Can absorb or deflect ({{taglink|repulsor|true}}) projectiles. Individual weapons can be set to be intercepted or not by the shield using a [http://en.wikipedia.org/wiki/Mask_(computing) bitmask] (see [[Shield Interception Tag Use]]). Visually represented as a translucent sphere, with control over colour and texture; by default the shield is invisible ({{taglink|visible|false}}).<br />
<br />
See the [[#shield]] sub-table section for other tags specific to this type.<br />
<br />
===StarburstLauncher===<br />
Fires a projectile that rises vertically for {{taglink|weaponTimer}} seconds, then turns towards its target. It can optionally track targets and accelerate from a low initial velocity. Before spring 92.0 was the only weapon that can be {{taglink|targetable}} and act as an {{taglink|interceptor}}. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.<br />
<br />
{{tag<br />
|name = weaponTimer<br />
|type = float<br />
|default = 0.0<br />
|description = The time in seconds during which the missile ascends vertically before turning towards its target.<br />
}}<br />
<br />
===TorpedoLauncher===<br />
Fires a projectile that will behave ballistically out of water and like a missile in water. Usually used with {{taglink|waterWeapon|true}} so they can fire underwater and target underwater units. An aircraft carrying a [[#TorpedoLauncher]] is a special case, the weapon turns into an [[#AircraftBomb]] projectile that will spawn a torpedo projectile on impact with water. Visually represented by a pointed black cuboid, usually the default object is replaced by a 3D model. <br />
<br />
{{tag<br />
|name = subMissile<br />
|type = bool<br />
|default = false<br />
|description = Can the torpedo leave the water and target units and positions on land?<br />
}}<br />
<br />
===NoWeapon===<br />
Not actually a '''WeaponType''', but an individual weapon requested by Spring to 'fill in the gaps' if a unit claims to have a weapon which isn't actually defined. There needs to be only one of these weapons and it is created by setting {{taglink|weaponName|"NOWEAPON"}} rather than by the {{taglink|weaponType}} tag.<br />
<br />
==Sub Tables==<br />
<br />
===damage===<br />
The damage subtable lists how many hit points the weapon depletes against each armor class (See [[Armordefs.lua]]). It is a key-value map of armor class names and damage values. The special <code>default</code> entry is as the name suggests the default damage applied to any unit which does not belong to a listed armor class, or to shields.<br />
<br />
For example a weapon which deals 100 damage by default but only 50 to units in the 'tank' armor class:<br />
<br />
<code><pre>damage = {<br />
default = 100,<br />
tank = 50,<br />
}</pre></code><br />
<br />
===shield===<br />
The preferred way to create a shield or repulser is to use the shield subtable rather than the old shield tags. <br />
<br />
The following tags are repulser specific:<br />
<br />
{{tag<br />
|name = repulser<br />
|type = bool<br />
|default = false<br />
|description = Does the shield [http://dictionary.reference.com/browse/repulse?s=t repulse] (deflect) projectiles or absorb them? Btw its [http://springrts.com/mantis/view.php?id=4206 not repulsOr, but repulsEr]!}}<br />
<br />
{{tag<br />
|name = force<br />
|type = float<br />
|default = 0.0<br />
|description = The force applied by the repulser to the weapon - higher values will deflect weapons away at higher velocities.}}<br />
<br />
{{tag<br />
|name = maxSpeed<br />
|type = float<br />
|default = 0.0<br />
|description = The maximum speed the repulser will impart to deflected projectiles.}}<br />
<br />
{{tag<br />
|name = visibleRepulse<br />
|type = bool<br />
|default = false<br />
|description = Is the (hard-coded) repulse effect rendered or not?}}<br />
<br />
The following tags are general behaviour for all shields:<br />
<br />
{{tag<br />
|name = interceptType<br />
|type = int<br />
|default = 0<br />
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this shield can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptedByShieldType}} will be intercepted by this shield (See [[Shield Interception Tag Use]]).}}<br />
<br />
{{tag<br />
|name = armorType<br />
|type = string<br />
|default = ""<br />
|description = Specifies the armorclass of the shield; you can input either an [[Armordefs.lua|armorclass]] name OR a unitdef {{xtaglink|Gamedev:UnitDefs|name}} to share that unit's armorclass.}}<br />
<br />
{{tag<br />
|name = smart<br />
|type = bool<br />
|default = false<br />
|description = Determines whether or not projectiles fired by allied units can pass through the shield (<code>true</code>) or are intercepted as enemy weapons are (<code>false</code>).}}<br />
<br />
{{tag<br />
|name = exterior<br />
|type = bool<br />
|default = false<br />
|description = Determines whether or not projectiles fired within the shield's radius can pass through the shield (<code>true</code>) or are intercepted (<code>false</code>).}}<br />
<br />
{{tag<br />
|name = energyUse<br />
|type = float<br />
|default = 0.0<br />
|description = The amount of the energy resource consumed by the shield to absorb or repulse weapons, continually drained by a repulser as long as the projectile is in range.}}<br />
<br />
{{tag<br />
|name = radius<br />
|type = float<br />
|default = 0.0<br />
|description = The radius of the circular area the shield covers.}}<br />
<br />
{{tag<br />
|name = power<br />
|type = float<br />
|default = 0.0<br />
|description = Essentially the maximum allowed hit-points of the shield - reduced by the <code>damage</code> of a weapon upon impact.}}<br />
<br />
{{tag<br />
|name = startingPower<br />
|type = float<br />
|default = 0.0<br />
|description = How many hit-points the shield starts with - otherwise the shield must regenerate from <code>0</code> until it reaches maximum {{taglink|power}}.}}<br />
<br />
{{tag<br />
|name = powerRegen<br />
|type = float<br />
|default = 0.0<br />
|description = How many hit-points the shield regenerates each second.}}<br />
<br />
{{tag<br />
|name = powerRegenEnergy<br />
|type = float<br />
|default = 0.0<br />
|description = How much energy resource is consumed to regenerate each hit-point.}}<br />
<br />
{{tag<br />
|name = rechargeDelay<br />
|type = float<br />
|default = 0.0<br />
|description = The delay in seconds before a shield begins to regenerate after it is hit.}}<br />
<br />
The following tags control the visual aspects of the shield:<br />
<br />
{{tag<br />
|name = visible<br />
|type = bool<br />
|default = false<br />
|description = Is the shield visible or not?}}<br />
<br />
{{tag<br />
|name = visibleHitFrames<br />
|type = int<br />
|default = 0<br />
|description = The number of frames a shield becomes visible for when hit.}}<br />
<br />
{{tag<br />
|name = badColor<br />
|type = float[3]<br />
|default = {1.0, 0.5, 0.5} (Red)<br />
|description = The RGB colour the shield transitions to as its hit-points are reduced towards <code>0</code>.}}<br />
<br />
{{tag<br />
|name = goodColor<br />
|type = float[3]<br />
|default = {0.5, 0.5, 1.0} (Blue)<br />
|description = The RGB colour the shield transitions to as its hit-points are regenerated towards its maximum {{taglink|power}}.}}<br />
<br />
{{tag<br />
|name = alpha<br />
|type = float<br />
|default = 0.2<br />
|description = The alpha transparency of the shield whilst it is visible.}}<br />
<br />
===customParams===<br />
The <code>customParams</code> subtable of a WeaponDef allows the game designer to give their weapons custom attributes, which can then be accessed via lua gadgets and widgets. It is a map (key-value pair indexed table) of strings. When accessing these attributes in lua the strings can be turned back into numbers, bools or even tables. This gives great control to game designers to essentially implement their own behaviour tags.<br />
<br />
There are no additional tags specific to this subtable<br />
<br />
==Examples==<br />
Some games may have most WeaponDefs integrated into their [[Gamedev:UnitDefs#Examples|UnitDefs]].<br />
<br />
S44 and MC:L implement an [http://en.wikipedia.org/wiki/Object-oriented_programming OOP] paradigm with [http://en.wikipedia.org/wiki/Inheritance_(computer_science) inheritance].<br />
<br />
<br />
{{ExampleRepoLinks<br />
|path = weapons/<br />
|entity = WeaponDefs<br />
}}<br />
<br />
[[Category: Game Dev]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Lua_MoveCtrl&diff=11388Lua MoveCtrl2014-06-30T13:25:20Z<p>Anarchid: setmovedef is not very old.</p>
<hr />
<div>[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}<br />
<br />
= ScriptMoveType =<br />
== Enable/Disable ==<br />
'''Spring.MoveCtrl.Enable'''<br />
( number unitID ) -> nil<br />
<br />
'''Spring.MoveCtrl.Disable'''<br />
( number unitID ) -> nil<br />
<br />
== Tags ==<br />
'''Spring.MoveCtrl.SetTag'''<br />
( number unitID, number tag ) -> nil<br />
<br />
'''Spring.MoveCtrl.GetTag'''<br />
( number unitID ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetProgressState'''<br />
( number unitID, number state | "done" | "active" | "failed" ) -> nil<br />
<br />
== Physics ==<br />
'''Spring.MoveCtrl.SetGravity''' <br />
( number unitID, number gravity ) -> nil<br />
<span class=note>N.B. gravity here is a multiplier to Game.gravity</span><br />
<br />
'''Spring.MoveCtrl.SetDrag'''<br />
( number unitID, number drag ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetGroundOffset'''<br />
( number unitID, number offset ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetWindFactor'''<br />
( number unitID, number windFactor ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetPhysics'''<br />
( number unitID,<br />
number posX, number posY, number posZ,<br />
number velX, number velY, number velZ,<br />
number rotX, number rotY, number rotZ ) -> nil <br />
<br />
'''Spring.MoveCtrl.SetPosition'''<br />
( number unitID,<br />
number posX, number posY, number posZ ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetVelocity'''<br />
( number unitID,<br />
number velX, number velY, number velZ ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetRelativeVelocity'''<br />
( number unitID,<br />
number relvelX, number relvelY, number relvelZ ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetRotation'''<br />
( number unitID,<br />
number rotX, number rotY, number rotZ ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetRotationVelocity'''<br />
( number unitID,<br />
number rotVelX, number rotVelY, number rotVelZ ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetRotationOffset'''<br />
( number unitID,<br />
number rotOffX, number rotOffY, number rotOffZ ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetHeading'''<br />
( number unitID, number heading ) -> nil<br />
<br />
== Options ==<br />
'''Spring.MoveCtrl.SetNoBlocking'''<br />
( number unitID, boolean noblock ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetLimits'''<br />
( number unitID,<br />
number minX, number minY, number minZ,<br />
number maxX, number maxY, number maxZ ) -> nil <br />
<br />
'''Spring.MoveCtrl.SetTrackSlope'''<br />
( number unitID, boolean trackslope ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetTrackGround'''<br />
( number unitID, boolean noblock ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetExtrapolate'''<br />
( number unitID, boolean on ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetShotStop''' <span class="warning">Currently a no-op</span><br />
( number unitID, boolean shotstop ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetSlopeStop''' <span class="warning">Currently a no-op</span><br />
( number unitID, boolean slopestop ) -> nil<br />
<br />
'''Spring.MoveCtrl.SetCollideStop'''<br />
( number unitID, boolean collidestop ) -> nil<br />
<span class=note>Enable both SetCollideStop and SetTrackGround to enable MoveCtrlNotify(unitID, unitDefID, unitTeam, data) call-in, data was supposed to indicate the type of notification but currently never has a value other than 1 (where 1 means "unit hit the ground")</span><br />
<br />
= MoveType-Controlling =<br />
<br />
'''Spring.MoveCtrl.SetMoveDef''' {{new|94.0}}<br />
( number unitID, number moveDefID | string moveDefName ) -> boolean success<br />
<span class=note>NOTE: string moveDefName needs to be in '''lowercase''', notwithstanding the fact that it may be in another case in the movedef table.<br />
</span><br />
<span class=note>NOTE: all Set*MoveTypeData functions support the following number keys:<br />
maxSpeed<br />
maxWantedSpeed<br />
repairBelowHealth<br />
</span><br />
<br />
'''Spring.MoveCtrl.SetAirMoveTypeData''' {{new|0.81}}<br />
( number unitID, string key, value ) -> nil<br />
( number unitID, table values ) -> nil<br />
<span class=note>supported keys:<br />
numbers:<br />
wantedHeight<br />
myGravity<br />
maxBank<br />
maxPitch<br />
turnRadius<br />
maxAcc<br />
maxAileron<br />
maxElevator<br />
maxRudder<br />
booleans:<br />
collide<br />
useSmoothMesh<br />
NOTE: not all keys and not all values may work correctly.<br />
[[SetMoveTypeDataExample|Example usage]]</span><br />
<br />
'''Spring.MoveCtrl.SetGroundMoveTypeData''' {{new|0.81}}<br />
( number unitID, string key, value ) -> nil<br />
( number unitID, table values ) -> nil<br />
<span class=note>supported keys:<br />
numbers:<br />
baseTurnRate<br />
turnRate<br />
accRate<br />
decRate<br />
maxSpeed<br />
maxReverseSpeed<br />
requestedSpeed<br />
requestedTurnRate<br />
booleans:<br />
floatOnWater<br />
NOTE: not all keys and not all values may work correctly.<br />
[[SetMoveTypeDataExample|Example usage]]</span><br />
<br />
'''Spring.MoveCtrl.SetGunshipMoveTypeData''' {{new|0.81}}<br />
( number unitID, string key, value ) -> nil<br />
( number unitID, table values ) -> nil<br />
<span class=note>supported keys:<br />
numbers:<br />
wantedHeight<br />
turnRate<br />
accRate<br />
decRate<br />
altitudeRate<br />
currentBank<br />
currentPitch<br />
booleans:<br />
collide<br />
useSmoothMesh<br />
bankingAllowed<br />
dontLand<br />
airStrafe<br />
NOTE: not all keys and not all values may work correctly.<br />
[[SetMoveTypeDataExample|Example usage]]</span><br />
<br />
[[category: Lua]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Map,_Game,_And_Unit_Development_Programs&diff=12959Map, Game, And Unit Development Programs2014-01-20T21:13:57Z<p>Anarchid: /* Scripting And Unit Stats files */ STARTED A REVOLUTION IN SPRING ANIMATION WORKFLOW</p>
<hr />
<div>[[Engine_Development|Development]] < {{FULLPAGENAME}}<br />
<br />
A Comprehensive list of tools to make Spring content.<br />
<br />
*Those that are Open Source are marked with a <font color="red">*</font><br />
*Those that are Free are marked with a <font color="blue">*</font><br />
*Those that Cost are marked with a <font color="green">*</font>'''<br />
<br />
=== Image Editing ===<br />
# '''[http://krita.org/ Krita]'''<font color="red">*</font><font color="blue">*</font> digital painting application, cross platform, with 16bit image support.<br />
# '''[http://www.gimp.org Gimp]'''<font color="red">*</font><font color="blue">*</font><br />
# '''[http://www.adobe.com/products/photoshop/main.html Adobe Photoshop]'''<font color="green">*</font><br>-> The most widely used image editing program ever.<br />
# '''[http://www.getpaint.net Paint.NET]'''<font color="red">*</font><br>-> Basically an expanded version of Paint. Contains many functions such as layers, and is much easier to use then The Gimp.<br />
<br />
=== 3d Modeling ===<br />
<br />
# '''[http://blender.org Blender]'''<font color="red">*</font><font color="blue">*</font><br>FREE-> The most used open-source modeller that has its own way of doing things.<br />
# '''[http://www.wings3d.com/ Wings 3D]'''<font color="blue">*</font><font color="red">*</font><br>FREE-> Probably the most popular modeller for Spring.<br>-> Easy to learn modelling and UV mapping environments.<br>-> Excellent introduction to using it can be found [http://www.wings3d.com/doghouse.php here]. <br>-> For help on how to UV map with it just ask around.low poly<br />
# '''[http://www.anim8or.com/main/index.html Anim8or]'''<font color="blue">*</font>'''<br />
# '''[http://www.autodesk.com/products/autodesk-3ds-max/overview 3DS MAX]'''<font color="green">*</font><br>-> The most widely used and acclaimed modelling program ever. Used in creation of many games and movies (The Matrix). One of the three major modelling programs used by professionals.<br>-> The s3o plugin for 3DS MAX can be found here. NOTE: This is not backwards compatible with versions prior to 7. Also this only exports: '''[http://taspring.clan-sy.com/temp/s3oexport.dle broken link fix if possible]'''<br />
# '''[https://www.lightwave3d.com Lightwave]'''<font color="green">*</font><br>-> A popular modelling program that's been around a long time. One of the three major modelling programs used by professionals.<br />
# '''[http://www.rhino3d.com/ Rhinoceros]'''<font color="green">*</font><br>-> Uses a lot of nurbs surfaces. <br />
# '''[http://www.turbosquid.com/gmax GMAX]'''<font color="blue">*</font><br>-> Great for learning as it is 3DS MAX v4 without rendering and has game packs for a fair amount of games. It is locked in exporting however there are a few workarounds.<br />
# '''[http://www.autodesk.com/products/autodesk-maya/overview MAYA]'''<font color="green">*</font><br>-> The other most widely used and acclaimed modeling program. Used in creation of many games and movies. One of the three major model programs used by professionals.<br />
<br />
===3d Model converters/Assemblers===<br />
<br />
# '''[[upspring|UpSpring]]'''<font color="blue">*</font><font color="red">*</font><br>-> Help, information, manual and tips can be found here: '''[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=2839&start=0 Forum]<br>-> This is the only other way to get files into the [[About_s3o|s30]] file format for Spring other then the [[About_s3o|s30]] plugin for 3DS MAX.<br />
# '''[http://springrts.com/phpbb/viewtopic.php?f=9&t=28156 S30 <-> OBJ Converter]'''<br />
<br />
===Sound/Audio Editors and Recorders===<br />
<br />
# '''[http://audacity.sourceforge.net/ Audacity]'''<font color="blue">*</font><font color="red">*</font><br>-> Audacity is a free, easy-to-use audio editor and recorder for Windows, Mac OS X, GNU/Linux, and other operating systems.<br />
# '''[http://www.goldwave.com/ GoldWave]'''<font color="green">*</font><br>-> GoldWave is a commercial digital audio editing software developed by GoldWave Inc for Windows. It was first released to public in April 1993, and is similar to applications like the open source Audacity.<br />
# '''[http://www.sonycreativesoftware.com/products/soundforgefamily.asp Sound Forge]'''<font color="green">*</font><br>-> The Sound Forge is an digital audio production suite includes everything you need to quickly get from raw audio to finished master. Use this suite to create and edit stereo and multichannel audio files with speed and precision. Efficiently analyze, record and edit audio, digitize and restore old recordings, model acoustic environments, design sound for multimedia, and master replication-ready CDs.<br />
# '''[http://www.speech.kth.se/wavesurfer/ WaveSurfer]'''<font color="blue">*</font><br>-> Wavesurfer is an audio editor widely used for studies of acoustic phonetics. Wavesurfer provides basic audio editing operations, such as excision, copying, pasting, zero-crossing adjustment, and effects such as fading, normalization, echo, inversion, reversal, replacement with silence, and DC-removal, but, in view of its scientific orientation, does not offer effects of interest to musicians such as flange.<br />
<br />
=== Scripting And Unit Stats files ===<br />
# '''[http://springfiles.com/spring/tools/scriptor-v1 Scriptor]'''<font color="blue">*</font><font color="red">*</font><br>-> The by far best compiler for your handmade .bos scripts into endless lines of letters and numbers that the TA engine reads. The program is large, easy to operate and with broad error tracing (well, better than the other two alternatives). While other versions of this program sometimes refuse to compile on-off functions, this download is guaranteed to work in every condition.<br />
# '''[http://springfiles.com/spring/tools/cobbler-v4 Cobbler]'''<font color="blue">*</font><br>-> This is a very simple script compiler that converts your newly written .bos files understood by humans into a hexadecimal .cob gibberish used by the TA engine. Beware, however, that this program may fail to compile some perfectly valid scripts and it doesn't always tell where the alleged error lies either. Parts of the program are in French.<br />
# '''[http://springrts.com/phpbb/viewtopic.php?f=9&t=24702&p=460639 Servo]'''<font color="blue">*</font><br>-> Rhad's awesome but somewhat buggy animation scripting program. It features keyframed animation script generation from a 3D positioner.<br />
# '''[https://github.com/Anarchid/blender2lus blender2lus]'''<font color="blue">*</font><font color="red">*</font><br>-> A Blender addon that allows Spring lua unitscripts (for assimp models only) to be authored in Blender, with (almost) all the goodies involved therein.<br />
# '''[http://springrts.com/phpbb/viewtopic.php?f=14&t=25104 Spring Poser by knorke]''' A not-yet-so-usefull gadget-widget-unitscript brewage that allows you to "pose" units by moving & rotating their pieces. It can then save the posed position as a list of Move & Turn commands.<br />
# '''[http://springrts.com/phpbb/viewtopic.php?f=23&t=24499 CEG Browser/Spawn by CarRepairer]''' Spawn particle effects from a menu, ie if you want to reuse effects from another game.<br />
# '''[http://springrts.com/phpbb/viewtopic.php?f=23&t=25847 piece tree widget]''' Print an ascii view of a units piece hierachy. Might be usefull to create notes for scripting.<br />
# '''[http://springrts.com/phpbb/viewtopic.php?f=67&t=23391 bos2lua converter page by CarRepairer]''' Converts .bos scripts to .lua scripts.<br />
# '''[[ToolBox]]''' A game-mutator with some tools for modding. Contains newest version of some of the above scripts plus others.<br />
<br />
=== Map Creation ===<br />
<br />
# '''[[Maps:SpringMapEdit|SpringMapEdit]]'''<font color="blue">*</font><font color="red">*</font><br>-> Our very own complete map making solution, created by Frostregen.<br />
# '''[http://www.springfiles.com/show_file.php?id=2441 Beherith's mapconv]'''<font color="blue">*</font><font color="red">*</font><br>-> The latest map compiler, supports all features of maps while still retaining backwards compatibility with previous scripts. <br />
# '''[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=2420 SMD Creator]'''<font color="blue">*</font><font color="red">*</font><br>-> Maelstroms SMD creator<br />
# '''[http://www.bundysoft.com/L3DT/ L3DT Large 3D Terrain Generator]'''<font color="blue">*</font><font color="green">*</font><br>-> Commercial Map Maker, standard version is free, but pro version requires payment but includes all the tools required to make an SD7 Spring map from scratch.<br />
# '''[http://code.google.com/p/conflictterra/wiki/MapsAndRocks#Coordinate_Helper_Widget Coordinate helper widget]''' Need to find lots of coordinates, for example to position units? Log the coordinates into a file just by placing markers, no more pen&paper!<br />
# '''[http://www.world-machine.com/ World Machine]''' Commercial terrain generation software, can output height and diffuse textures.<br />
# '''[http://en.wikipedia.org/wiki/Bryce_(software) Bryce3D]''' Shareware terrain generation software.<br />
# '''[http://en.wikipedia.org/wiki/Carrara_(software) Carrara]''' Shareware 3D software.<br />
<br />
[[Category:Development]]</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Assimp&diff=2153Assimp2013-02-19T16:48:43Z<p>Anarchid: /* Blender Workflow Tutorial */ addzored rx-90 mega hax</p>
<hr />
<div>[[Engine_Development|Development]] < [[Game_and_Unit_development|Game Development]] < {{FULLPAGENAME}}<br />
<br />
== Blender Workflow Tutorial ==<br />
<br />
This is a stub containing a simple outline of a Blender workflow. Disclaimer: I'm not modeling expert, there may be a better way to do this.<br />
<br />
<br />
# Open an existing Blender model or import a different format through the File menu (File > Import).<br />
# In the 3D view, drag out the secret panel from the right.<br />
# In that panel, select Display > Shading > GLSL.<br />
# Make sure you have a lamp in your scene while in this mode or your model will be dark.<br />
# Applying texture: <br />
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.<br />
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.<br />
## Hit A to select all your faces.<br />
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.<br />
## If you don't see any faces you'll need to add the UVMap to a new texture:<br />
### In the Properties view click on Textures (checkerboard icon).<br />
### Click on Add New Texture (plus icon).<br />
### Select Type = Image or Movie.<br />
### Under Image, click on the image icon and choose your image file.<br />
### Under Mapping, select Coordinates = UV.<br />
### Under Influence > Diffuse, check Color and make sure it's 1.00.<br />
## To add a normalmap:<br />
### Repeat steps 5.1 to 5.5.<br />
### Under Image Sampling, check Normal Map.<br />
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.<br />
## You'll need to do this for each piece.<br />
# Piece hierarchy:<br />
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.<br />
## Make sure all the pieces are descending from one single piece.<br />
# Setting piece origins:<br />
## Select a piece.<br />
## Place the 3D cursor where you want the origin to be (left-click).<br />
## Click on Object > Transform > Origin to 3D Cursor.<br />
## You can now rotate your pieces:<br />
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.<br />
### Rotate.<br />
## Do this for all your pieces.<br />
# Preparing for Spring:<br />
## Select your root piece.<br />
## Press Shift-C to put the 3D cursor in the center of the world.<br />
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.<br />
## Rotate your whole model so that it's -90 degrees. You can do this by typing "R X -90". This will make your model lie on its back.<br />
## Click Object > Apply > Rotation & Scale.<br />
# Save your model.<br />
# Select all the pieces of your model, ignore the lamp.<br />
# Click on File > Export > Collada.<br />
# Check "Export Only Selected" and export.<br />
# The dae file will be used as your object.</div>Anarchidhttps://springrts-wiki.p2004a.com/mediawiki/index.php?title=Game_and_Unit_development&diff=8080Game and Unit development2012-07-23T07:00:09Z<p>Anarchid: /* Modeling */</p>
<hr />
<div>[[Engine_Development|Development]] < {{FULLPAGENAME}}<br />
<br />
=Game development=<br />
This information is meant to help newcomers learn how to develop their own games for the Spring Engine.<br />
<br />
<br />
==General==<br />
* [[Map,_Mod,_And_Unit_Development_Programs|Development Tools]]<br />
*[[Game structure]]<br /><br />
*[[Game specification|Game specification]]<br /><br />
*[http://answers.springlobby.info/ Q&A Site for the Spring Engine]<br />
*[http://springrts.com/phpbb/viewtopic.php?f=14&t=26409| Porting TA content to Spring]<br />
<br />
==Resources==<br />
*[[General_Resources|Free Assets]]<br />
*[[SpringTutorialGame|Spring Tutorial Game]] - (attempt to create) a "template game" for new projects.<br />
*[[LUPS]]<br />
*[[Chili]]<br />
*[[IceUI]]<br />
*[[RedUI]]<br />
*[[LOLUI]]<br />
*[[Map Making: Feature Placer|Feature Placer]]<br />
<br />
==Reference==<br />
*UnitDefs (.fbi, .lua)<br />
**[[Units-UnitDefs|UnitDefs]] - define the attributes of units<br />
**[[Unit_Categories]] - define which weapon type aim at which targets<br />
**[[Unit_collision_volumes | Unit Collision Volumes]] - collision detection<br />
*WeaponDefs (.tdf, .lua)<br />
**[[Weapon Variables]] : This is the most up to date<br />
**[[Units:WeaponMainDir]]<br />
**[[Weapons:Antinukes]]: All about antinukes.<br />
*MoveDefs*<br />
**[[Units:MoveTypes]]<br />
*FeatureDefs (objects on the map, wrecks of destroyed units)<br />
**[[Units-FeatureDefs]]<br />
*Global game variables (modrules.lua)<br />
**[[Modrules.lua]]<br />
*[[CEG]] Particle effects (explosions etc)<br />
<br />
*Misc<br />
**[[VirtualFileSystem]]<br />
**[[MouseCursors]]<br />
**[[Units:Textures]]<br />
**[[Units:Buildpics]]<br />
**[[Sidedata.lua]]<br />
**[[Units:FlankingBonus]]<br />
**[[Armordefs.lua|Units: Armor classes]]<br />
**[[Mod Development:Archives|Game Development:Archives]]<br />
**[[Mod Development:Sidepics|Game Development:Sidepics]]<br />
**[[CustomUnitIcons|Game Development:Custom unit icons]]<br />
<br />
=Unit Scripting/Animations (.cob, .bos, .lua)=<br />
Unit scripts animate units and are needed for various function such as firing weapons.<br />
* [[Animation-CobLuaDifferences | Differences of .lua and .cob unit scripts]]<br />
<br />
==Lua Animations==<br />
*[[Animation-LuaScripting]]<br />
**[[Animation-LuaCallins]]<br />
**[[Animation-LuaCallouts]]<br />
**[[Animation-CobLuaDifferences]]<br />
<br />
==COB Animations==<br />
The binary '.cob' file format is a compiled '.bos' script. To convert a '.bos' script file to '.cob' file you will need [[Scriptor]]<br />
<br />
*[[Animation-CobOverview]]<br />
**[[Animation-CobExamples]]<br />
**[[Animation-CobAnimation]]<br />
**[[Animation-CobCallins]]<br />
**[[Animation-CobConstants]]<br />
**[[Animation-CobThreads]]<br />
**[[Animation-CobHitByWeaponID]]<br />
*[[Units:LuaCOB]] - how to interface COB with LUA<br />
*[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]<br />
* [http://springrts.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]<br />
<br />
=Modeling =<br />
Spring supports different 3d representations: '[[About_s3o|.s3o]]' and '[[About_3do|.3do]]', and additionally a variety of common model formats as supported by the ASSIMP library. The biggest difference between these formats is the workflow to create a new unit. There are also s3o exporter plugins for '3ds-max' and an older version of 'blender' so that texturing and modeling can be done using these.<br />
In contrast: when you model an '.3do' you have to use [[upspring]] currently.<br />
<br />
The animation with can either be done using 'lua' or 'COB/BOS' is does not depend on either, see rigging/animation. For new units use 'lua' scripting.<br />
<br />
=Engine Related=<br />
* [[Download_Testing]] - Test the compatibility of your game on upcoming versions of the Spring engine.<br />
<br />
=Tutorials=<br />
===Game Development Tutorials===<br />
*[[The Complete Guide To Making A Spring Game]] - A fairly comprehensive getting started tutorial.<br />
*[http://springrts.com/phpbb/viewtopic.php?f=14&t=26409| Porting TA content to Spring]<br />
*<strike>[[Simple Mod Tutorial|Simple Game Tutorial]]</strike> - needs to be updated<br />
<br />
===Modeling Tutorials===<br />
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]<br />
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]<br />
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]<br />
<br />
===Texture Tutorials===<br />
* [http://springrts.com/phpbb/viewtopic.php?f=57&t=22392 DDS Textures: How To]<br />
* [http://springrts.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]<br />
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]<br />
<br />
[[Category: Unit_development]]<br />
[[Category:Game development]]</div>Anarchid