FreeSpace Wiki - User contributions [en]

Pof

2008-07-02T08:47:57Z

WMCoolmon: Redirecting to *.POF

#REDIRECT [[*.POF]]

VP

2008-07-02T08:47:28Z

WMCoolmon: Redirecting to *.VP

#REDIRECT [[*.VP]]

Tbm

2008-07-02T08:46:54Z

WMCoolmon: Redirecting to Modular Tables

#REDIRECT [[Modular Tables]]

Tbl

2008-07-02T08:46:07Z

WMCoolmon: Redirecting to Tables

#REDIRECT [[Tables]]

Shrouding the Light

2008-01-12T22:42:28Z

WMCoolmon:

==General==
Status: Released by Blaise Russel in 2004

==Description==

A year has passed since the destruction of the Lucifer and the flight of the Shivan armada. In the year 2336, the Terran and Vasudan peoples attempt to reclaim their former empires and piece together their shattered lives. However, dissidents and splinter groups from within jeopardise their hopes of peace - fighting for independence or against hated alien foes. In the midst of all this turmoil, you are transferred, from the safety of the 1st Battlegroup of Vasuda to the 13th Battlegroup's PVD Guardian and the troubled hotspot of Deneb...

==Related Links==
[http://mysite.wanadoo-members.co.uk/sbre/stl/stl.htm Shrouding the Light website] 
[http://www.hard-light.net/forums/index.php/topic,26961.0.html Shrouding the Light SCP release thread]

[[Category:User-made_Campaigns]]

Shrouding the Light

2008-01-12T22:41:54Z

WMCoolmon:

==General==
Status: Released by Blaise Russel in 2004

==Description==

A year has passed since the destruction of the Lucifer and the flight of the Shivan armada. In the year 2336, the Terran and Vasudan peoples attempt to reclaim their former empires and piece together their shattered lives. However, dissidents and splinter groups from within jeopardise their hopes of peace - fighting for independence or against hated alien foes. In the midst of all this turmoil, you are transferred, from the safety of the 1st Battlegroup of Vasuda to the 13th Battlegroup's PVD Guardian and the troubled hotspot of Deneb...

==Related Links==
[http://mysite.wanadoo-members.co.uk/sbre/stl/stl.htm Shrouding the Light website]
[http://www.hard-light.net/forums/index.php/topic,26961.0.html Shrouding the Light SCP release thread]

[[Category:User-made_Campaigns]]

Sandbox

2008-01-07T00:17:41Z

WMCoolmon:

{| cellpadding=5 style="text-align: center; margin: 0 0 1em 1em; background: #113; border: 2px #33D solid; border-collapse: collapse;"
|-
! | Campaign Name
! | Release
! | Requirements
! | Voice Acted
! | Missions
! | Author
! | Additional Mods

|- style= "border: 1px #22D solid;"
| colspan="7" align="left" | '''Pre Awesome War Campaigns'''

|- style= "border: 1px #22D solid;"
! valign = "top" rowspan="2" | [[Awesome Campaign]]
| Yes
| [[SCP]]
| Yes
| 55
| [[Mr FRED]]
| Yes
|-
| colspan="6" align="left" | ''The Awesomians attack the Borons in the Awesome War. Is there any hope when the Borons launch the Boran?''

|- style= "border: 1px #22D solid;"
! valign = "top" rowspan="2" | [[Another Awesome Campaign]]
| Demo
| Retail
| No
| 2
| [[Mrs FRED]]
| No
|-
| colspan="6" align="left" | ''The Borons take their revenge on the Awesomians with their new friends, the Hippies.''

|- style= "border: 1px #22D solid;"
| colspan="7" align="left" | '''Post Awesome War Campaigns'''

|- style= "border: 1px #22D solid;"
! valign = "top" rowspan="2" | [[A Sucky Campaign]]
| No
| [[BetaMax Mod]]
| No
| 0
| [[Uncle FRED]]
| No
|-
| colspan="6" align="left" | ''I'll add something later. I guess. I dunno.''

|- style= "border: 1px #22D solid;"
! valign = "top" rowspan="2" | [[A Less Sucky Campaign]]
| October 2008
| [[Pants mod]]
| Yes
| 9000
| [[Papa FRED]]
| Yes
|-
| colspan="6" align="left" | ''Pants!''

|}

* M - Includes additional mods
* C - cutscenes
* V - Voice acted
{| cellpadding=5 style="text-align: center; margin: 0 0 1em 1em; background: #113; border: 2px #33D solid; border-collapse: collapse;"
|-
! | Campaign Name
! | Release
! | Requirements
! | Missions
! | Author
! |

|- style= "border: 1px #22D solid;"
| colspan="7" align="left" | ''Pre Awesome War Campaigns''

|- style= "border: 1px #22D solid;"
! | [[Awesome Campaign]]
| Released
| [[SCP]]
| 55
| [[Mr FRED]]
| M
| C
| V

|- style= "border: 1px #22D solid;"
! | [[Another Awesome Campaign]]
| Demo
| Retail
| 2
| [[Mrs FRED]]
|
| C
|

|- style= "border: 1px #22D solid;"
| colspan="7" align="left" | ''Post Awesome War Campaigns''

|- style= "border: 1px #22D solid;"
! | [[A Sucky Campaign]]
| Abandoned
| [[BetaMax Mod]]
| 0
| [[Uncle FRED]]
|
|
| V

|- style= "border: 1px #22D solid;"
! | [[A Less Sucky Campaign]]
| October 2008
| [[Pants mod]]
| 9000
| [[Papa FRED]]
| M
|
|

|}

Sandbox

2008-01-04T03:34:03Z

WMCoolmon:

{| cellpadding=5 style="text-align: center; margin: 0 0 1em 1em; background: #113; border: 2px #33D solid; border-collapse: collapse;"
|-
! | Campaign Name
! | Released
! | Requirements
! | Voice Acted
! | Missions
! | Author
! | Additional Mods

|- style= "border: 1px #22D solid;"
| colspan="7" align="left" | ''Pre Awesome War Campaigns''

|- style= "border: 1px #22D solid;"
! | [[Awesome Campaign]]
| bgcolor="green" | Yes
| [[SCP]]
| bgcolor="green" | Yes
| 55 Missions
| [[Mr FRED]]
| bgcolor="green" | Yes

|- style= "border: 1px #22D solid;"
! | [[Another Awesome Campaign]]
| bgcolor="orange" | Demo
| Retail
| bgcolor="red" | No
| 2 Missions
| [[Mrs FRED]]
| bgcolor="red" | No

|- style= "border: 1px #22D solid;"
| colspan="7" align="left" | ''Post Awesome War Campaigns''

|- style= "border: 1px #22D solid;"
! | [[A Sucky Campaign]]
| bgcolor="red" | No
| [[BetaMax Mod]]
| bgcolor="red" | No
| 0 Missions
| [[Uncle FRED]]
| bgcolor="red" | No

|}

* M - Includes additional mods
* C - cutscenes
* V - Voice acted
{| cellpadding=5 style="text-align: center; margin: 0 0 1em 1em; background: #113; border: 2px #33D solid; border-collapse: collapse;"
|-
! | Campaign Name
! | Release
! | Requirements
! | Missions
! | Author
! |

|- style= "border: 1px #22D solid;"
| colspan="7" align="left" | ''Pre Awesome War Campaigns''

|- style= "border: 1px #22D solid;"
! | [[Awesome Campaign]]
| Released
| [[SCP]]
| 55
| [[Mr FRED]]
| M
| C
| V

|- style= "border: 1px #22D solid;"
! | [[Another Awesome Campaign]]
| Demo
| Retail
| 2
| [[Mrs FRED]]
|
| C
|

|- style= "border: 1px #22D solid;"
| colspan="7" align="left" | ''Post Awesome War Campaigns''

|- style= "border: 1px #22D solid;"
! | [[A Sucky Campaign]]
| Abandoned
| [[BetaMax Mod]]
| 0
| [[Uncle FRED]]
|
|
| V

|- style= "border: 1px #22D solid;"
! | [[A Less Sucky Campaign]]
| October 2008
| [[Pants mod]]
| 9000
| [[Papa FRED]]
| M
|
|

|}

FS2 Open Lua Scripting

2007-05-27T07:29:44Z

WMCoolmon: Updated page to reflect changes in newer builds

This page is intended as a crash-course in Lua scripting as it relates to Freespace 2. It's only meant to get you started with Lua scripting - more advanced concepts such as metatables will not be covered.

You don't need to read the Appendices, but I recommend at least reading the "Optimizing" section if you're doing much scripting.

'''IMPORTANT: This page was last updated on 5/27/2007 and assumes you are using the most up-to-date build at that time, [http://www.hard-light.net/forums/index.php/topic,47201.0.html C05202007]. There may be slight syntax differences with significantly newer or older builds. You should also make sure you are using a build from the Unstable/HEAD CVS branch.'''

== What You Need ==
You will need a basic understanding of how to open and edit computer files, a copy of Freespace 2, and an open mind. Any kind of prior scripting experience will be immensely helpful, but you shouldn't need any to understand this document.

Here we go!

Note: Although all the examples should not cause syntax errors anywhere, they may not work in certain places. For example, you have to load a mission before you can get handles to ships in the mission.

== Scripting hooks ==
A scripting hook is a segment of Lua code, that is run at a specific place in FS2_Open. Some scripting hooks, such as $GameInit, are executed only once. Others, such as state hooks, are executed every frame. Others may be executed only when a specific action occurs (such as a keypress or a ship warping out).

There are three different types of hooks. All hooks are parsed and loaded into memory when they are read, so there is no speed difference. Also, the optional field "+Override: YES" can be used to make a scripting hook completely override fs2_open's usual behavior. (For example, for the HUD, this would completely disable the default fs2_open HUD and use the scripting version instead)

For the sake of organization, information on different scripting hooks can be found in the wiki page for the table that they are actually in.

=== Return hook ===
$Hook: 2 + #Mission.Ships
This works like a normal table variable, except that you can use scripting functions as well.

=== Normal hook ===
$Hook: [
gr.setColor(255, 255, 255)
gr.drawString("Hello, world!")

return 2 + #Mission.Ships
]
A normal hook is denoted by [ and ]. Whatever is within the brackets is passed to the Lua interpreter. This means that you cannot use table-style ;; comments within brackets; you must use Lua's comments.

However, you can still use it with a .tbl field that takes a value, using the "return" command. In this case, even though the other lines are still run, the $Hook: variable would be set to the same value as in the 'Return hook' example.

=== File hook ===
<pre>$Hook: [[script.lua]]</pre>
A file hook loads the scripting from the file in the data/scripts directory. In all other respects, it is the same as a normal hook.

== Comments ==
A "comment" (in any programming or scripting language) is a block of a script that is ignored. In Lua there is only one kind of comment, which starts with double-dashes. Any time you put two dashes in a Lua script outside of a string, the rest of the line will be ignored. (This is the same as putting a double-semicolon in a Freespace table)

For example, this:
--Load a mission for use in the mainhall
Mission.loadMission("sm2-10.fs2") --Use 'King's Gambit' for now.

Will do exactly the same thing as this:
Mission.loadMission("sm2-10.fs2")

== Variables ==
A variable is the simplest kind of thing that there is in Lua. All it really does is hold data; no more, no less. They really aren't that scary. Here are some different types of variables

--Number variable
life = 42

--String variable
name = "Bob"

--Boolean variables
smoking = true
healthy = false

--Userdata (Handle or object) variable
player = Mission.Ships['Alpha 1']

--Nil variable
--Erases a previously set variable
life = nil

--Member variable of userdata. Can be any of the above types.
player.Name = "Ship"

Note: Although technically objects and handles are all userdata, it's easier to just think of every object and handle as being different types of variables.

=== Arrays ===

An array is a special type of variable, that holds multiple variables. The '''''index''''' of all Lua arrays starts at 1.

--Set the fifth element of array to 1
a[5] = 12
--Set n to the fifth element (tehe)
n = a[5]
--n will be 12

The size of arrays may also be determined using the '''''#''''' sign

--Create an array
a = {2, 4, 6, 8}
--Set s to the size of the array
s = #a
--s will be 4

== Libraries ==
In order to gain access to the FS2_Open engine through scripting, you must use the FS2_Open libraries. Each library represents a different section of the engine. In addition, libraries may be referenced one of two ways: the full name, or a shorthand version of the name made up of two letters. Here, the same setColor '''''function''''' is used twice.

Graphics.setColor(255, 255, 255)
gr.setColor(255, 255, 255)

For the sake of easy reading, I've used the longhand version of names in the wiki. However, I recommend you learn the shorthand versions as they're generally faster to work with when scripting.

To get a full list of library functions, use the "-output_scripting" command line parameter. This should create a file called scripting.html, with a list of the different libraries, functions, and types supported by that build. (Use a web browser to open it)

== Functions ==
A function is an instruction to Lua to do something. It may change variables, or it may call (activate) other functions. Functions are the meat of scripting; they get everything done. Essentially, they are much like an individual SEXP.

As a result, this section is pretty tough, but covers almost all of the specific knowledge you'll need to work within Lua.

=== Function vocabulary ===
* '''''Return value''''' - Data that a function returns. Any data that a function returns may be stored in a variable.
* '''''Arguments''''' - Data that is given to a function. May be data itself, a variable containing the data, or even the return value of another function.
* '''''Call''''' - To run a function.

=== Typical function use ===
Example: This will write "Alpha 1" in the upper-left corner of the screen.
player = Mission.Ships['Alpha 1']
Graphics.setColor(255, 255, 255)
Graphics.drawString(player.Name, 5, 5)

* Line 1: In the first line, the "Ships" array of the mission library is indexed. Because 'Alpha 1' is specified, it will set either the handle to the ship named 'Alpha 1', or it will return an invalid handle if Alpha 1 is dead or there was no Alpha 1 in the mission to begin with. Because the player variable is set to the result of the Array index, it will receive whatever handle is accessed by the array. Result After the first line, the player variable is a ship handle to the ship named "Alpha 1" in the current mission.

* Line 2 In the second line, the "setColor" function is used to set the current drawing color to pure white. Unlike getShipByName, it takes at least three arguments, all numbers - the red, green, and blue scale of the current color, from 0 to 255. It's always a good idea to use the setColor function before doing any drawing in scripting, as the engine can and will change the current color between scripting hooks. Result Current drawing color is set to pure white

* Line 3 In the third line, the drawString function takes three arguments - a string, followed by two numbers. The string specifies the text to write, the numbers specify the x and y position of the upper-left corner of the written text. As you can see, we've directly used a '''''member variable''''' of the player variable to fill the first argument. Because we got the ship handle by its name, the Name variable will be the same as the name that we got it by ("Alpha 1"). Result After the third line, "Alpha 1" will appear in the upper-left corner of the string in white text.

Note: Numbers and certain types of userdata will automatically convert to strings. In all other cases, functions will give an error if you try to use the wrong type of argument.

Debugging note: If Alpha 1 were dead in the above example, you would get an error about 'trying to index a nil value' because it would not be able to run the getName() function.

=== Userdata functions ===
Handles and objects may also have functions.

Example: This will write the number of subsystem's on Alpha 1's ship in the upper-left corner.
player = Mission.Ships['Alpha 1']
Graphics.drawString(#player, 5, 5)

As before, we get the handle to the Alpha 1 ship with the Ships array.

=== Optional arguments ===

Sometimes you don't have to use an argument. For example, the setColor function has an optional fourth argument - how opaque the color should be. If the argument isn't used, the color is totally opaque. These two lines do the same thing:

Graphics.setColor(255, 255, 255)
Graphics.setColor(255, 255, 255, 255)

== Quick, a full example! ==
By this point, you may be bored of all this exposition. So here's your typical "Hello, World!" example.

For this amazing trick, we'll make our very own splash screen. Turn off all Freespace 2 mods, and create a file called "scripting.tbl" in your data/tables directory. Open that up in a text editor, and write:
#Conditional Hooks
$Version: 3.7
$On Splash Screen: [
--Set the color to white
Graphics.setColor(255, 255, 255)
--Write "Hello, world!"
Graphics.drawString("Hello, world!", 5, 10)
]
+Override: YES
#End

Now, when you start up FS2_Open, you should see "Hello, world!" in the upper-left, as it loads.

== Control structures ==
A control structure is a series of statements that let you change how a script runs, based on some condition - say, a ship is dead, or the life of a certain ship has fallen below a certain amount.

=== If statements ===
If statements are a way to check if something is some way or not. All if statements have the form:
if (something) then
(execute)
end

(something) can be true, or false. If it's true, then (execute) will be run. If it's false, then the script will skip down to "end" and go on from there.

To check that a handle is valid:
ship = Mission.Ships['Alpha 2']
if ship:isValid() then
--This will always happen while Alpha 2 is alive
Graphics.drawString("MACKIE LIVES!", 5, 10)
end

To check a variable value
x = 42
y = 23
if x < y or x is y then
--We never get here, because x is bigger than y
end

=== For statements ===
A for statement is generally used to iterate through a list.

Example:
This bit of scripting will run through all of Alpha 2's subsystems if she isn't dead, and display a list of them in the upper-left.

ship = Mission.Ships['Alpha 2']
if ship then
num_subsys = #ship
x = 5
y = 5
for i=1,num_subsys do
--Use the i variable to go through the ship's subsystems,
--and to change the y position of the text.
gr.drawString(ship[i].Name, x, y + i*10)
end
end

=== More information ===
For other keywords you can use with control structures, see the [http://www.lua.org/manual/5.0/manual.html#2.5.2 Lua Documentation]

For more detailed information on if statements and other types of control structures, see the [http://lua-users.org/wiki/ControlStructureTutorial Lua-users wiki]

== Appendices ==

There's more depth to scripting than what's covered above. To make the rest of the article shorter, I've put the topics still within the scope of this article, but not necessary to know in most cases, down here.

However, I HIGHLY recommend you read the optimizing scripting section.

=== Appendix: Optimizing scripting ===

Because fs2_open is written in C, which is much faster than Lua, it is much better to store variables in C and provide Lua functions to work with them. In addition, to keep Lua scripting from messing with C scripting and to make it as friendly as possible, there are a number of safeguards to catch problems, in most of the Lua functions.

As a result, whenever you're working with a value provided by a library or object function, you should set it to a Lua variable if you're going to use it more than 1-2 times due to the large overhead resulting from the interface.

Thus, even though it may look like "Name" is a member variable of the ship handle, it is actually a function that performs 3-4 validity checks before returning the value, which must also be converted from C to Lua. Setting a variable to the return value of the function means that you can use that variable wherever you want to use the ship name using the native Lua environment.

=== Appendix: Debugging scripting ===

Unfortunately, the Lua interpreter provides only limited debugging information about hooks. (Supposedly, it will provide more information about scripting within user functions, but I haven't tested that claim yet)

Generally, error messages complaining about referencing or indexing a 'nil value' occur because a function could not return a handle, so it returned nil. Some functions also return false to indicate that the handle is correct, but due to some kind of wrong information being passed, it couldn't complete.

Generally, you should check all handles before using them:
player = Mission.Ships['Alpha 1']
if player:isValid() then

end

With all uses of the player handle falling in the "if" statement.

=== Appendix: Function types ===

Here's all the different kinds of functions you can have:
--A function provided by itself
x = cos(y)
--A function provided by a library
x = Math.cos(y)
--A function provided by a userdata variable.
x = y:cos()
In every case, x would be set to the cosine of y, which is 1.

Note: You must use a ":" with userdata functions, as in the example. This tells Lua that it needs to give the function the value of the variable that it's being called from.

=== Appendix: Making your own functions ===
So, let's make the doSomething() function do, well, something.
doSomething = function()
color = "red"
end
As you can see, creating a function is much like creating a variable; you just use function() instead of the value, then write what you want the function to do. To end the function, you just write "end"

Now, let's use our new doSomething() function.
color = "black"
doSomething()
--After using doSomething(), color is now red

Functions can also '''''return''''' values.
--Make a new function
doSomethingElse = function()
return 10
end
x = 0
doSomething()
--x is now 27
x = doSomethingElse()
--x is now 10

=== Appendix: Variable Scope ===
The '''''scope''''' of a variable is the area where it exists. Writing <tt>local</tt> in front of the variable name will tell Lua that the variable should only exist within that function or hook.

Note that this means that if you use the same variable name in two different hooks without using local, the same variable will be used.

Note:

You may find it useful to have some way of distinguishing global variables from local ones, to remind yourself that the value does carry over. For example, starting global variable names with "g_".

Example: The following will draw the text "Media VP" in the upper-left corner of the main hall, even though the variable is set in a different hook than it is used in.

#Conditional Hooks
$Version: 3.7
$On Game Init: [g_mod = "Media VP"]

$State: GS_STATE_MAIN_MENU
$On Frame: [Graphics.drawString(g_mod, 0, 0)]
#End

=== Appendix: Variable Types ===
Variables can hold different types of data. These basic types are:

==== Boolean ====
A boolean is a simple variable - it can be true, or false.
--It's Monday, and Dilbert is at the office
working = true
--Oops, he just opened Solitaire
working = false

==== Numbers ====
A number is any variable that holds (As you might've guessed) a number. A number will automatically convert into a string, if needed.
--A variable can be a whole number, like this
x = 5
--Or it can be a decimal value
x = 3.141592654
--Or you can divide two numbers for a fraction
x = 3/4

==== Strings ====
A string is a variable that holds a series of characters, and a character is any number, letter, or symbol on your keyboard (and then some). Basically, strings are the way that words and sentences are passed around in Lua.
--A cow says moo!
cow = "moo"
--A friend's name
friend = "Bob"
Note that actual string content is contained within double quotation marks, to mark it as a string.

==== nil ====
nil isn't really a variable type, but it is important. nil means that a variable doesn't hold anything. If you want to get rid of a variable, you just set it to be nil.

--Today I got a new dog
dog = "Spot"
--But then he ran away
dog = nil

Any time an error says that a variable is nil, it usually means that it doesn't exist (Double-check your spelling).

==== Userdata/objects ====
Objects (or "userdata", as they are known in Lua) is a variable that can contain other variables, or functions. Variables or functions within an object are known as "member variables" or "member functions".

--Assuming we have a my_car object, this will copy it to your_car
your_car = my_car
--Congratulations! But maybe you want to customize it?
--Note how I refer to the member variable, color
your_car.color = "Red"

==== Handles ====
A handle isn't technically a Lua type, but handles are used a lot in FS2_Open Lua scripting. Essentially, a handle is a variable that refers to a specific object; but doesn't actually contain that object's data. An example is the "shipclass" type; it doesn't actually contain the data in ships.tbl, it just serves to reference the ship class so that you can get and set data.
--Get the "GTF Ulysses" ship type
--For this, I use the ShipClasses array
ulysses = tb.ShipClasses['GTF Ulysses']
--Now get rid of the handle
ulysses = nil
--Even though we've gotten rid of the handle, the Ulysses will still exist.

In situations where a handle variable is an object, you must set the entire variable at once; you cannot change elements of the array individually.
--So intead of this...
ship = mn.Ships[1]
ship.Position["y"] = 0

--You would go...
ship = mn.Ships[1]
pos = ship.Position["y"]
pos["y"] = 0
ship.Position = pos

=== Appendix: External Lua references ===
* [http://www.devmaster.net/articles/lua/lua1.php DevMaster.net - Lua Scripting 101]
* [http://www.lua.org/manual/5.1/ Official Lua 5.1 Reference Manual]
* [http://www.lua.org/pil/ Programming in Lua]
* [http://www.lua-users.org/ lua-users.org]

Scripting API

2007-03-19T02:03:44Z

WMCoolmon: Partial update with info from Ade

The FS2_Open scripting API is intended to be as cross-platform and as language non-specific as possible. However, it is generally assumed that the most popular language will be Lua.

=New System (HEAD)=
==Introduction==
===Foreword: Who I Think You Are===
For the duration of this document, I will generally assume that you, the reader, are a coder who is interested in Doing Something With Scripting. This means that I will cover the simple stuff first, and mostly focus on how to define and use hooks and variables. However, I will try to make this document also have some value to scripters interested in how things work "under the hood".

===What the heck is ADE?===
"Ade" is the name of the new scripting backend. I chose this name after I did a complete overhaul of the scripting backend, somewhere around the time that the official fs2_open codebase was split into the "HEAD" (unstable) and "3.6.9" (stable) branches. HEAD uses ADE, 3.6.9 does not.

Ade itself is based on the idea that the most effective way to generate scripting support is via an object-oriented method that mirrors the way that Lua does things. It uses a master array of objects with the type "ade_table_entry", which in turn denote their respective children and parent objects.

Ade itself also defines a number of structs and macros that are used to easily extend functions and variables into Lua.

===A little on Lua - Why?===
Lua is a crossplatform scripting language that has a syntax similar to Python and C. When adding a scripting component to FS2_Open was discussed, Lua was chosen for the following reasons:
* Crossplatform support
* Whitespace-independent syntax
* Lightweight parser and compact default libraries
* Support for semi-object-oriented syntax

Rather than define things using traditional constructs such as structs and classes, Lua uses a system of "tables" and "metatables". This is, quite frankly, a pain in the arse to understand. However, I will do my best to give a crash course here.

====Tables====

Essentially, a Lua table is just a big array. The items stored in the array (or table) can be accessed using either numbers or strings. They can also be accessed using traditional brackets [], or via traditional class syntax (using a period).

myTable[1] = "Macaroni"
myTable["Food"] = "Steak"
print(myTable[1]) --outputs "Macaroni"
print(myTable["Food"]) --outputs "Steak"
print(myTable.Food) --also outputs "Steak"

====Userdata====
Userdata is a lua type that consists of user-specified data. All ADE libraries, handles, and objects are defined using userdata and a metatable.

====Metatables====
The interesting thing about lua tables is that they can also be used as '''metatables'''. A metatable is a table that is associated with an object, which provides a series of functions that control how the object or table will be accessed. This may include operators (+ - * / etc) and what happens when you try to index userdata or change the value of an index of userdata. All metatable functions start with "__", and are called when their respective operator is used or respective event occurs.

[[media:Adeagram.gif|Diagram showing ADE's use of metatables]]
 [http://www.lua.org/manual/5.1/manual.html#2.8 Lua Documentation: Metatables]

==Part One: Conditional Hooks==
===Introduction===
Unlike the old scripting system, the new cool thing in Ade is support for conditional hooks. These mean a little more work for coders just starting out, but they help to improve the efficiency and flexibility of Lua.

===Table sytax===
See [[Scripting.tbl#Format_3]]

===Defining conditions===
# Open up parse/scripting.cpp and parse/scripting.h in your favorite text editor. Find the "CHC_*" defines in parse/scripting.h
# Add your define to the end of the list; make sure to use the last #define's number + 1.
# Add your condition to the Script_conditions[] array in parse/scripting.cpp. The string will be used for the variable name in the table (The "$" is added automatically).
# Scroll down to the ConditionedHook::ConditionsValid() function. In that function:
## Add a case for you #define. Put it in the same relative position as you put it in the Script_conditions[] array. (This is not necessary, but it keeps things organized)
## The value that the modder specifies after your condition is provided by scp->data.name. (For example, if the modder says "$Version: 3.6.9", then scp->data.name will contain "3.6.9"). If your condition has something to do with a related object, then use the "objp" variable.
## Use the value provided by scp->data.name to check your condition
## Return false if the condition is not met. '''''Do not return true'''''. This is unnecessary, and will cause any conditions after yours to be ignored. But don't forget to "break".

That's it. _All_ actions will now be able to use your condition to check whether they ought to execute or not.

===Defining actions===
# Open up parse/scripting.cpp and parse/scripting.h in your favorite text editor. Find the "CHA_*" defines in parse/scripting.h
# Add your define to the end of the list; make sure to use the last #define's number + 1.
# Add your condition to the Script_actions[] array in parse/scripting.cpp. The string will be used for the action name in the table (The "$" is added automatically).

Now you're done...with parse/scripting.*, anyway.

# Go to the place in the code you want the action to be triggered.
# Call IsConditionOverride(action #define) to determine if the modder wants to override the retail Freespace 2 action. By convention, conditional hooks also override any other types of hooks, and IsConditionOverride should come '''before''' everything else.
## If this action involves an object (Like rendering a ship), pass the pointer to the object using the second argument to IsConditionOverride(). This will be used to check any conditions specified.
# Call Script_system.RunCondition(action #define) to actually run the method. By convention, this should be called after the retail Freespace 2 action or other types of hooks, so the modder can change anything he doesn't like.
## If you want the modder to be able to return a value, define a type using the format character (2nd argument) and a destination buffer with the data variable (3rd argument). If you want to pass an object, but don't want to involve a return value, set these fields to '\0' and NULL, respectively.
## If this action involves an object (Like rendering a ship), don't forget to pass the pointer to the objp argument (4th argument).
## A typical call might look like this:
# Use Script_system.SetHookObject() or Script_system.SetHookVar() to define hook variables (Hook variables are contained within the "hv" library).
# Don't forget to use Script_system.RemHookVars() when you're done.

Congratulations! Now anyone will be able to use your hook.

====Example:====
Script_system.SetHookObject(2, "Self", warping_object, "SomeOtherObject", some_other_object);
if(!Script_System.IsConditionOverride(CHC_WARPIN, warping_object))
{
//Handle the warpin normally
}
Script_system.RunCondition(CHC_WARPIN, '\0', NULL, warping_object)
Script_system.RemHookVar(2, "Self", "SomeOtherObject");

In the table, you would use this hook like so:
#Conditional Hooks
$Shipclass: SJ Sathanas
$On Warp In: [
gr.setColor(255, 0, 0)
gr.drawString("Danger! Supernova imminent! Sathanas detected at " .. tostring(Self.Position), 200, 200)
]
#End

=Old System (3.6.9)=
==Part One: Basic API and Scripting Hooks ==
===Things To Know===
;Script_system:This object abstracts a scripting session. It is generally used to allow for easy construction/destruction of whatever is necessary to initialize scripting system objects, and make sure that the right language session data is passed. Its constructor takes one argument, the name of the scripting session (for easy debugging)
;Script_system.CreateLuaSession(libraries):Initializes a Lua session. Until this is called, you will not be able to use Lua at all and fs2_open should ignore code chunks that use it.
;Script_system.ParseChunk(debugname):Parses a 'code chunk'. These are snippets of code encapsulated by symbols such as square brackets or parentheses. It stores a handle to the parsed script in memory (Probably bytecode).
:script_system.RunBytecode(handle):Actually executes a code chunk that has been parsed with ParseChunk
====Example====
This snippet of code (using FS2_Open functions) will parse a file that has scripting after each "$Global:" variable identifier. After all the scripting has been parsed, it will evaluate every hook, once.
//Create script system object
script_system Script_system;

//Create array that holds a series of scripting hooks
std::vector<script_hook> Script_globalhooks;

//Initialize Lua
Script_system.CreateLuaState(Lua_libraries);

//Parse file
read_file_text("scripting.tbl");
reset_parse();
while(optional_string("$Global:"))
{
Script_globalhooks.push_back(st->ParseChunk());
}

//Execute hooks
for(uint i = 0; i < Script_globalhooks.size(); i++)
{
Script_system.RunBytecode(Script_globalhooks[i]);
}

==Part Two: The Higher-Level Lua Library==
The Lua library is probably what you'll want to be the most familiar with, as it's where you'll edit to add functions, classes, libraries, and variables.

===Limitations===
* Lbraries can only contain functions, and not variables or arrays.
* All "arrays" must be an object with an indexer (see LUA_INDEXER define). I was not able to get this working originally, but I've got another idea on how to try this so if you really feel an array class would be best in a given situation, tell me.

===General conventions===
For the internal Lua API:
* All internal lua functions are prefixed with lua_
* All Lua library and object variables are prefixed with l_, so "l_Graphics".
* When failure occurs due to a bad type being passed, or a subsystem not being ready, LUA_RETURN_NIL is usually used.
* When failure lies with the content of data, rather than the circumstances or type, LUA_RETURN_FALSE is generally used where appropriate.

For Scripting:
* All variable names have the form of "EverySomethingIsCapitalized"
* All function names have the form of "doSomethingFast()"
* All object names have the form of "somethingneat"
* All library names are one capitalized word. For more than one word, the same syntax as variables(?)
* All library shortnames are two noncapitalized letters relating to the name. "Sound" -> "sd"
* So far, I've used three-letter noncapitalized variables for globals. But I may decide to switch to the normal variable convention soon, as it's MUCH clearer about what the variable is.

===Things To Know===
;lua_lib:Defines a Lua library.
;lua_obj:Defines a Lua object type (userdata).
;LUA_FUNC:Defines a Lua member function. Used with both lua_lib and lua_obj.
;LUA_VAR:Defines a Lua member variable. Only used with lua_obj.
;LUA_INDEXER:Defines Lua activity when brackets are used. Only used with lua_obj.

Once you invoke any of the above, it's not necessary to do anything else for it to be present in Lua.

===lua_lib===
lua_lib l_Base("Base", "ba", "Base Freespace 2 functions");
Defines a Lua library, which can contain member functions (But not any kind of variables).

Probably the simplest and most obvious to work with. The first field is the library name; the second is the shorthand version. The last is merely the description, which is only used for -ouput_scripting

===lua_obj===
lua_obj<object_h> l_Ship("ship", "Ship object", &l_Object);
Defines a lua object, via a C++ template. The <> defines what type of C data the object will hold. In general, it's better to pass a handle to Freespace data (such as the ship_info struct) than to try and copy the entire thing. For 'static' data - such as image handles or species indices - a simple <int> with the index of the item will suffice. For perishable data, you may want to store a unique identifier - say, an object's signature. In the above example, I use a helper struct that holds both a pointer to the object, and the object's signature. That way, all I need to do is check that the object at the pointer has the same signature to make sure that the handle is still valid.

The next two parameters are fairly obvious - the name of the object (becomes the metatable name), and the description in output_scripting.

The last parameter warrants some explanation - it is the parent of the object. Multiple levels of derived objects aren't supported, and a derived object must have the same type as its parent object, since all of the parent object's functions will generally only support the parent object's data type, and it's just needlessly complicating.

===LUA_FUNC===
LUA_FUNC(newVector, l_Math, "[x, y, z]", "Vector object", "Creates a vector object")
One of the two most used of the Big 5. The same tactics used for a LUA_FUNC are virtually the same for LUA_VAR and LUA_INDEXER.

There are two components to LUA_FUNC. The first is the arguments (above); the second is the actual body.

The arguments are, the function name (As it will appear in Lua). This is also used internally for the C compiler, so it is not actually a string. The second argument is the library or object that the function is a part of. So, the above example is the "newVector" function of the "Math" library, and would be accessed by calling "Math.newVector()"

The third, fourth, and fifth arguments are all purely descriptive, but you should always fill them in if applicable to ensure good documentation. The first is the arguments that the function will take; they may be in any form you please, but I have generally used the "required, required, [optional, optional]" form. As you can see, in the example all arguments are optional.
The second argument is the return value. If the function returns different types, you should note it here.
The last argument is the basic description. Because it can be pretty long, I've sometimes split it up across multiple lines.

Now, for the body of the define:
{
vec3d v3 = vmd_zero_vector;
lua_get_args(L, "|fff", &v3.xyz.x, &v3.xyz.y, &v3.xyz.z);
return lua_set_args(L, "o", l_Vector.Set(v3));
}
'''Defining function variables'''

In the first line, we create the C vector object that we're going to return, and initialize it to 0 (since all arguments are optional).

'''Parsing arguments passed to your function in Lua'''

In the second line, lua_get_args is used to parse the arguments from Lua. This function is big and messy and takes care of all the warnings and errors that may be caused by invalid types and such. The first argument, L, is just the lua state data that must be passed along; ignore it but don't forget it. The second argument is a list of characters that specify the variable types. These characters represent the following C types:
*b - Boolean
*d - Double
*f - Float
*i - Int
*s - String
*x - Fix
*o - lua_obj (See later)
Finally,
*| - Denotes all variables after this as being optional.

All arguments after the formatting string should be pointers to the variables you want lua_get_args to set. Be careful; compilers will not catch if you use the a boolean where you have specified a double, for example. Optional variables will only be changed if a value is specified.
'''Note:''' If a wrong type is passed to an optional variable of your function, that variable will be skipped, although variables after it may be changed.
'''Note:''' You do pass pointers to (char *), so you end up passing a char **. Lua will take care of all memory concerns; don't try to deallocate the pointer yourself.

When using the 'o' parameter, you can get objects in one of two ways:
vec3d v3;
vec3d *v3p;
lua_get_args(L, "oo", l_Vector.GetPtr(&v3p), l_Vector.Get(&v3));
"v3p" would be a pointer to the first object's data, while "v3" would merely hold a copy of the data in the second object. Because it's not necessary to allocate or copy as much memory, getting pointers may be faster; but at the same time, you should be careful not to change the data in the pointer unless you really want to, as it will change the actual object's data. '''''When you define a member function, the object will be passed as the first argument'''''. As a result, this lua_get_args call would be suitable for, say, a function that copies the data passed in the argument to the calling object - "vectora:copyData(vectorb)".

lua_get_args will return the number of arguments parsed, or 0 if the required variables requirement was not met. So when working with required variables (or an object), you should generally use the form:
if(!lua_get_args(...))
return LUA_RETURN_NIL;
The exception being when you want to actually know the number of arguments, in which case you should handle 0 appropriately. (More on LUA_RETURN_NIL later)

'''Return values'''

Return values are set via the lua_set_args function, which works pretty much exactly the same as lua_get_args, except in reverse. The differences:
*Actual variables, rather than pointers, are passed.
*Objects use their .Set() function (and there is no SetPtr() function).
*No | character

Always use "return lua_set_args", or one of the following:
*LUA_RETURN_NIL - Function returns nothing.
*LUA_RETURN_FALSE - Function returns false.
*LUA_RETURN_TRUE - Function returns true.

Yes, you can have multiple return values. The syntax in Lua is:
a, b = Library.theFunction() --In Lua

'''Operators'''

Definitely an advanced topic, which I will write when someone has need for it. These are slightly crazy as you can reverse objects and I don't fully understand what happens when you try to use an operator on two different objects that have different actions defined for that one operator.

Look at the vector class for what I've done with operators; if you got the LUA_FUNC section, you should be able to understand it. Note that the lua_isnumber() functions take the almighty L, and the argument index to check (Starting from 1).

Look up the lua_Operators[] array for the full list of operators, as well as a bit of descriptive text.

===LUA_VAR===
LUA_VAR(Name, l_Species, "String", "Species name")
Arguments are variable name, object that this variable will be a member of, the type that this variable is, and a brief description of what the variable is.

Variables defined by fs2_open are functions. This is generally the easiest and fastest way to go about doing things, since Lua is only a part of the much-larger fs2_open base, which cannot be going through the API to get at variables - not without causing massive code rewrites and slowdowns.

So, if you want an object to have actual data, you'll have to rely on the internal C dataset to do this. See the vector class for a good example.

'''Actually doing stuff with LUA_VAR'''

The two big differences with LUA_VAR are the LUA_SETTING_VAR macro, and how lua_get_args is used. Much like with functions, the first argument of lua_get_args will be the object that the variable is a member of. The second argument is optional, and is the value that the variable may be set to.

Here's the body for the above example, minus some safeguarding to make it easier to read:
char *s = NULL;
int idx;
if(!lua_get_args(L, "o|s", l_Species.Get(&idx), &s))
return LUA_RETURN_NIL;

if(LUA_SETTING_VAR && s != NULL) {
strncpy(Species_info[idx].species_name, s, sizeof(Species_info[idx].species_name)-1);
}

return lua_set_args(L, "s", Species_info[idx].species_name);

You should consider LUA_SETTING_VAR to be the safest way of determining whether or not a variable is actually being set, because it uses Lua's own internal guidelines to determine this.

It is good practice to return the value of the variable after changing it, so the scripter can check the value afterwards.

===LUA_INDEXER===
LUA_INDEXER(l_ShipTextures, "Texture name or index", "Texture", "Ship textures")
First argument is the object, second is what can be placed in the brackets ([]), third is the type returned, and fourth is a description of what the array is.

The first argument passed to the indexer will be the parent object; the second, the index (This can be whatever you like - a number, a string, even an image handle, just as long as lua_get_args can handle it). The third, the value that the scripter wants the current index to be set to.

In all other respects, it is exactly like LUA_VAR; use LUA_SETTING_VAR to determine whether you are in setting mode or not.

File:Adeagram.gif

2007-03-19T01:59:57Z

WMCoolmon: "Adeagram" showing variable access and storage for the FS2_Open ADE scripting system.

"Adeagram" showing variable access and storage for the FS2_Open ADE scripting system.

Modular Tables

2007-03-18T09:24:41Z

WMCoolmon: speeling

Modular tables are SCP addition to the standard FreeSpace table system. XMTs (or eXtentable Modular Tables) offer capability to add new entries or alter already existing tables without any need of editing the 'parent' table file.

==Extendable Tables==
*[[ai_profiles.tbl]] can be extended with '''xxx-aip.tbm''' (XMT)
*[[armor.tbl]] can be extended with '''xxx-amr.tbm''' (non-XMT)
*[[hud_gauges.tbl]] can be extended with '''xxx-hdg.tbm''' (non-XMT)
*[[mflash.tbl]] can be extended with '''xxx-mfl.tbm''' (non-XMT)
*[[music.tbl]] can be extended with '''xxx-mus.tbm''' (non-XMT)
*[[objecttypes.tbl]] can be extended with '''xxx-obt.tbm''' (XMT)
*[[scripting.tbl]] can be extended with '''xxx-sct.tbm'''
*[[ships.tbl]] can be extended with '''xxx-shp.tbm''' (XMT)
*[[species_defs.tbl]] can be extended with '''xxx-sdf.tbm''' (XMT)
*[[stars.tbl]] can be extended with '''xxx-str.tbm''' (non-XMT)
*[[weapons.tbl]] can be extended with '''xxx-wep.tbm''' (XMT)
*[[weapon_expl.tbl]] can be extended with '''xxx-wxp.tbm''' (non-XMT)

==Other Related Tables==
*[[fireball.tbl]] can be '''''edited''''' with '''xxx-fbl.tbm''' file ([[fireball.tbl#Modular Fireball Table|special]])

==Important Notes==
*Modular table files should use the 'parent table' files sections.
*Completely new entries and also complete rewrites of entries in parent table file are always possible.
*For '''xxx-shp.tbm''' and '''xxx-wep.tbm'''
**Table entries in modular tables do not have to be complete. Partial entries can be used to alter the data found in parent table files when only some changes to the original are desired to be made.
**Adding '''+nocreate''' right after the entry's name prevents possible creation of partially undefined entry. For example if the parent table file lacked the entry that was included to the as a partial entry to the modular table file then the creation of partially undefined entry is possible which could cause problems with the game.
***Example:

$Name: @Subach HL-7
+nocreate

==Sample - Alpha-wep.tbm==
*Changes the speed of the ''Subach HL-7'' and also adds a faint grey trail to it.
*To create it make a text file using a text editor and save the file as '''''Alpha-wep.tbm''''' with the following contents to the proper folder (.../data/tables).

#Primary Weapons
$Name: @Subach HL-7
+nocreate
$Velocity: 650.0
$Trail:
+Start Width: 0.4
+End Width: 0.0
+Start Alpha: 0.35
+End Alpha: 0.0
+Max Life: 0.2
+Bitmap: Contrail
#End

[[Category:Tables]]

Scripting.tbl

2007-02-19T07:53:41Z

WMCoolmon: Added the content to the article.

'''''This feature requires SCP''''' 

----

The scripting table is used for scripting special features like alternate HUDs or ship viewer into the game.
 
'''Usefull references:'''
*'''[[FS2 Open Lua Scripting]]'''
*'''[[Scripting API]]'''
*'''[http://fs2source.warpcore.org/temp/scripting.html Scripting.html]'''
*'''[[Command-Line_Reference#-output_scripting|Command-Line Reference for creating scripting.html]]'''
*'''[http://lua-users.org/wiki/ Lua-Users Wiki]'''
*'''[http://www.lua.org/manual/5.0/ Reference manual for Lua 5.0]'''

==General Info==
*Scripting table consist of several sections
*All sections and most of the entries are optional
*All sections end with #'''End'''
*No scripting hooks are not executed on a separate thread, at least as of this writing. They are executed at given points in the code, and all other execution will not take place until a scripting hook has finished. This means that, in theory, a large and complicated enough script will cause noticeable lag or slowdown when executed.
*Information in this document applies only to the HEAD branch. Scripting in 3.6.9, or in any builds based on 3.6.9, is considered unsupported.
 
==Prerequisites==
===Frames===
One of the most important things to understand when reading this guide is the concept of "frames". (Experienced modders can probably skip this part) In gameplay, motion is achieved by making incremental changes every fraction of a second. A ship will be moved slightly, and then drawn to the screen. This happens 30-120 times a second; anything lower, and the game will become choppy and difficult to play.

There is also a difference in the moving of objects in-game, and the moving of objects onscreen. All ships are first "moved", in memory. This probably consists of physics calculations, that change the ship's position based on if their engines are turned on, or if they run into another object. After this, the game then renders the now-moved ships to what is referred to as a "backbuffer" - a place in memory that takes the place of the computer screen. Once rendering has finished, the backbuffer is instantly drawn to the screen. This prevents objects from flickering as they are drawn. You do not have to worry about flipping the backbuffer in scripting; FS2_Open will take care of that for you.

For scripting, '''it is important to understand that each block of code will therefore be executed several times a second, but only once per frame'''. However, the exact number of times per second will depend on how much work the computer has to do (And therefore how much time it takes) for each frame. To determine how much time you should consider to have passed, you must use the ba.getFrametime() function; which will return the approximate time the frame will take, in seconds. In addition, if you "move" a ship after it has already been rendered, the change will not become apparent until the next frame.

This does mean that if you want to make a block of text move across the screen, at a rate of 5 pixels per second, all you have to do is multiply the speed by the frametime:
<pre>#Global Hooks
$Global: [
--If the g_WheeXPosition variable does not exist,
--it means we are on the first frame.
--If that is the case, set it to zero.
if not g_WheeXPosition then
g_WheeXPosition = 0
end

--Move the text
g_WheeXPosition = g_WheeXPosition + (5 * ba.getFrametime())

--Draw "WHEE!!!"
gr.drawString("WHEE!!!", g_WheeXPosition, 10)
]
#End</pre>
 
===Hooks===
Scripting "hooks" form the basis of the scripting system. A "hook" simply refers to a point in the code where code to execute scripting has been added. The hook may then be added to a table, or added to a SEXP. In general usage, "hook" refers to an entry in scripting.tbl.

All hooks take the form of an identifer (such as $Global:), followed by brackets to determine what type of scripting is being executed. A lack of brackets also indicates a type of scripting execution. All current bracket configurations are listed below. Note that "$Hook:" is used merely as a placeholder, and should be replaced with the actual hook name ($Global:, $HUD:, $On Frame:, etc).
#<pre>$Hook: scripting</pre>Specifies one line of LUA scripting. In addition, the return value of that line will be passed to the interpreter and used (if applicable). Specifying a variable or value on this line will result in it being returned, as well.
#<pre>$Hook: [scripting]</pre>A single set of brackets pecifies a block of LUA scripting. Does not return a value unless explicitly specified. (Explicit specification is not possible at this time; but may be implemented in the future if/when more future hooks take a return value.)
#<pre>$Hook: [[scriptfilename.lua]]</pre>Double brackets specify a file. This file is read out of the data/scripts directory, and must include the file extension. You may specify a compiled lua file as a target as well; this may result in crossplatform issues for a mod, however.
 
====+Override====
Some hooks additionally take a +Override: field. This field uses the same bracket configurations as above. If a hook includes a +Override field, this hook always determines whether the default FS2_Open behavior that the hook is associated with will function, or will be disabled. This should be used in cases where scripting will replace the original FS2_Open behavior. For example:
<pre>$HUD: [
gr.setColor(255, 255, 255, 255)
gr.drawString("HUD Disabled", 50, 50)
]
+Override: true</pre>

Additionally, override hooks are (by convention) executed before FS2_Open behavior. The HUD hook override, for example, is executed before any part of the HUD is actually drawn.
 
==Sections==
* #'''Global Hooks'''
* #'''State Hooks''' (3.6.9)
* #'''Conditional Hooks''' (HEAD)
 
==#Global Hooks==

Global hooks are the simplest form of scripting hooks available. They are at preset locations in the code, and are generally executed every time that point is reached. Exceptions to this rule (such as the HUD hook) only depend on one or two variables to determine execution. All other scripting execution is determined by the modder.
 
===Format===
;'''$Global:''': Script in this section is executed almost immediately before each frame is drawn. This means that any scripting elements will be drawn, or take effect, after everything else, except for the "On Frame" conditional hook. It is not used with the standalone server. In addition, note that use of this hook should generally be avoided, since all scripting will have to be processed every frame.
;'''$Splash:''': This hook is executed once, when the splash images (PreLoad and PreLoadLogo) would be drawn. This hook should generally be used only for drawing the splash screen; any initialization could should be placed in GameInit. This hook is executed before virtually any other subsystem has been loaded, aside from the graphics and filesystem subsystems, so scripting elements such as the table and mission libraries will be nonfunctional.
*;'''+Override:''': Executed just before default splash images are loaded and displayed. Note that the frame is still drawn regardless; it is not necessary to flip the backbuffer manually.
;'''$GameInit:''': This hook is executed once, after all of the Freespace2 subsystems have been initialized. It is executed before the game switches to the main hall or, in the case of standalone server mode, begins the game.
;'''$Simulation:''': This hook is executed only during missions. It is executed after all damage, movement, physics, SEXPs, and other "physical" in-game changes have been applied. It is executed before anything has been rendered. This hook should be used only for damage, movement, and physics related scripting, as if the game needs to be rendered without any in-game time having been passed, this function will not be called.
;'''$HUD:''': The HUD hook is executed after the HUD has been drawn. Note that if the HUD is turned off, this hook will be disabled as well, until the HUD is turned back on.
*;'''+Override:''': Executed immediately before anything on the HUD is drawn, and controls whether the default FS2_Open is drawn.

==#State Hooks==

In Freespace2, a "state" more or less refers to a room. It may also refer to a separate mode - playing a mission is the GS_STATE_GAME_PLAY state. The main menu is the GS_STATE_MAIN_MENU state. This section should only exist in 3.6.9. It is included here for the sake of documentation; it has since been removed and superseded by the conditional hook system.
 
===Format===
;'''$State:''': Specifies the state name. A full list of states is located [http://fs2source.warpcore.org/cgi-bin/cvsweb/cvsweb.cgi/fs2_open/code/gamesequence/gamesequence.h?rev=2.10&content-type=text/x-cvsweb-markup within a source code file.] Search for "GS_STATE_MAIN_MENU" and look for other "GS_STATE" text.
*;'''$Hook:''': Executed after all of the state code has been executed, but before the game frame is actually drawn.
**;'''+Override:''': Determines whether the specified state is handled at all by Freespace. If true, then none of the loading or exit code for the state will be specified as well.

==#Conditional Hooks==
Scripting hooks are only available in HEAD builds. They consist of any number of conditions, followed by any number of actions. All available conditions and actions are located in the file generated by -output_scripting.

One way to think of conditional scripting is like this: The condition specifies the object that the action will apply to, or the place that the action will occur in. All conditions must be met for their associated actions to execute. Actions are associated with a set of conditions by simply adding them after that set of conditions. (Obviously, you may want to space out each pair of action/condition sets in the TBL to make it easier to read.)

The flexibility of conditional scripting comes in due to its inherent scalability. If you specify a mission and ship condition with a warpin action, that script will only be executed when the ship warps in on that particular mission. Removing the mission field will make that warpin scripting apply to the ship for all missions; or removing the ship field will make the warpin scripting apply to all ships in that mission.

This prompts the question: if this is all conditional scripting does, why not just use the global hook?
#Organization - conditional scripting is generally easier to read and modify because it is grouped in a standardized manner.
#Speed - All conditions can be evaluated by FS2_Open itself, without invoking the Lua interpreter at all.
#Scalability - As of the time of this writing, you can only have one global hook. Modular tables will simply replace it. With conditional scripting, if you want to specify additional actions for a set of conditions in a modular table file, you may do so.
 
===Format===
;'''$Condition:''': Where "$Condition:" is one of several conditions specified in scripting.html, such as $State: or $Ship:. Takes a value representing the object the condition should be checked against (such as a state, ship, or mission name)
;'''$Condition:''': ...
;'''...''':
;'''$Action:''': Where "$Action:" is one of several actions specified in scripting.html, such as $On Frame or $On Warp In. Takes a scripting hook, using the bracket configuration outlined at the top of this article.
;'''$Condition:''': ...
;'''...''':

A brief description of all Conditions and Actions at the time of this writing:
 
===Conditions===
;State: Controls execution based on what state FS2_Open is in, such as the main hall, options screen, or in a mission. The full list of states can be found in the source, as part of [http://fs2source.warpcore.org/cgi-bin/cvsweb/cvsweb.cgi/fs2_open/code/gamesequence/gamesequence.h?rev=2.10&content-type=text/x-cvsweb-markup gamesequence.cpp]. Search this file for "GS_STATE" to find the list
;Campaign: Controls execution based on the current campaign's filename. (It is under consideration to change this to the campaign's name, instead).
;Mission: Controls execution based on the current mission's filename. (Also under consideration).
;Object Type: Defines a specific object type that the action will apply for, such as a "Ship", "Asteroid", or "Jump Node".
;Ship: Defines a specific ship (name) that the action will apply for.
;Ship class: Defines a specific ship class (name) that the action will apply for.
;Ship type: Defines a specific ship type (name) that the action will apply for.
;Weapon class: Defines a specific weapon class (name) that the action will apply for.
;KeyPress: Experimental.
 
===Actions===
;On Frame: Executes immediately after the global scripting hook, which is right before the frame is drawn. Does not have an override. Like the global hook, you should generally avoid using this hook; however, it is appropriate for state hooks.
;On HUD Draw: Identical to the $HUD: hook.
;On Ship Collision: Executes when the specified object collides with a ship. Sets a handle in the HookVariables library with the name of the object type ("Weapon", "Debris", and so on) with the type of the object. If both objects are ships, the other object gains the name "ShipB". (If both ship objects define a collision hook, the variables will be swapped for the other ship, so the ship that the script is executing for will always be called "Script".) The override will disable FS2_Open code, as well as the other object's collision code. If both objects have an override set, only one of the objects' hooks will be used (Chosen arbitrarily). Note that the override receives the same variables.
;On Weapon Collision: Like the ship collision hook, but for weapons.
;On Debris Collision: Like the ship collision hook, except for debris.
;On Asteroid Collision: Like the ship collision hook, only for asteroids.
;On Object Render: Executes when the specified object is rendered. The override is run before the object is rendered, and both the hook and its override receive an "Object" variable of the object to be rendered.
;On Warpin: Run when a ship has begun warping in, immediately after everything has been set up for per-frame processing. This hook is only executed once, when the ship begins warping in. An override will disable _all_ behavior related to warpin. Both the hook and an override receive an "Object" handle in the HookVariables library, with the type of the object that is warping in.
;On Warpout: Same as warping in, except for warping out.
;On Death: Currently only valid for ships. Receives "Self" and "Killer" variables of the object and killer, respectively. Overriding it will override all default death behavior.
 
==Examples==
[[Script - Death Flash|Death Flash]] 
[[Script - Escort Reticle|Escort Reticle]] 
[[Script - Example HUD|Example HUD]] 
[[Script - Hud Pong|Hud Pong]] 
[[Script - Proximity Trigger|Proximity Trigger]] 
[[Script - Scripted Flak|Scripted Flak]] 
[[Script - Ship Viewer|Ship Viewer]] 
[[Script - Splash Screen|Splash Screen]] 
[[Script - Velocity Indicator|Velocity Indicator]] 

[[Category:Tables]]
[[Category:Scripting Examples]]

Source Code Project index

2007-01-28T06:28:52Z

WMCoolmon: Added Linux install method

===Getting Started with the Source Code Project===

#[[FSSCP Introduction]]
#[[Getting Freespace]]
#Installing FSSCP
#*[[FreeSpace Open Installer]]
#*[[Installing fs2_open|Installing FreeSpace Open without the Installer]]
#*[[Fs2_open_on_Linux]]
 
====Optional post-install====
[[Installing mods for fs2_open]]
 [[Troubleshooting]]
 [[Bug Reporting]]
 
====Errata====
[[FS2 Status Page]]
 [[FS2 data installation]]
 
 

===Getting Started with Development===
[[Coding In C]]
 [[Linux CVS Howto]]

[[Category:Source Code Project]]

Ships.tbl

2007-01-27T01:43:48Z

WMCoolmon: /* $Thruster: */

Table listed here is meant to be compatible with '''3.6.9 RC''' and in future also for '''3.6.9 release''' builds. For other builds see the links below.
 
Links to archived versions:
*[[Ships.tbl/CVS_version|CVS version of ships.tbl]]
*[[Ships.tbl/Retail_version|Retail version of ships.tbl]]
 
==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
**<nowiki>#</nowiki>'''Ship Classes'''
***Includes entries for every ship and also defines their attributes that are used in the game
***Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
**'''$Player Ship Precedence'''
***Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash. In [[Modular Tables]] this can be sometimes be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.
*Syntax: ''Name''

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: ''Value', (degrees)

===$Radius Mult:===
*Defines something???
*Syntax: ''Value'', (multiplier)

===$Length:===
*Defines the lenght of the engine wash
*Syntax: ''Value'', (meters)

===$Intensity:===
*Defines the strenght of the engine wash
*Syntax: ''Value'', (blast effect)

===Example===

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Table Options==
*Retail options will look like this


*SCP options are marked with red color
**Most of the entries in ships.tbl have been made optional. Only entries that have to be filled are $Name:, $POF file: and $Flags:.


===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. In [[Modular Tables]] this can be sometimes be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.
*Syntax: ''name'',
**Example: ''Ulysses''

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: ''name'',
**Example: ''TFight''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship. More species have been enabled, and all of these are defined in species_defs.tbl.
*Syntax: ''Terran'', ''Shivan'' or ''Vasudan''
*Syntax: ''Name'', as defined in species_defs.tbl
**Example: ''Terran''

===Technical description===
List of discriptive terms for techroom and ship selection screens.
Number after the quotes refers to tstrings.tbl (does this have any function?)

+Type: XSTR("", -1)
+Maneuverability: XSTR("", -1)
+Armor: XSTR("", -1)
+Manufacturer: XSTR("", -1)
+Description: XSTR("", -1)
$end_multi_text
+Tech Description: XSTR("", -1)
$end_multi_text
+Length: 20 m
+Gun Mounts: 4
+Missile Banks: 1

===$POF file:===
*filename of the model file (.pof) at data/models folder
*Syntax: ''Filename.pof''
**Example: ''fighter01.pof''

===$POF target file:===
*Syntax: ''Filename.pof''


===$POF target LOD:===
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Added to the code 13. Dec 2005
*Syntax: ''Value''


===$Detail distance:===
*Definies the distance where the change between different Levels-Of-Details (LODs) occurs
*Syntax: ''(Value, Value, ...)'' (distances from the model in meters)
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FS1 for ship lights. Nowadays we use glowmaps.
*Syntax: ''Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
**Example: ''42, 42, 224''

===$Show damage:===
*No known function. Best left alone to avoid possible compatibility issues.
*Syntax: ''YES'' or ''NO'', usually YES


===$Impact Spew:===
*Used to define the impact particle spew
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: ''Value''

===$Damage Spew:===
*Used to define the damage particle spew
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: ''Value''


===$Density:===
*This defines how hard you hit something. If you set it very high, a collission will severely damage your ship, and push the lower density object away; the higher the numbers are, the harder they will hit and the farther they will be pushed. Setting a density of 10 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid.
*Syntax: ''Value'', usually 1

===$Damp:===
*Damp affects how quickly you will accel/decel to your target velocity. Higher damp means slow acceleration and deceleration. The lower this number, the faster the ship responds. For example, specifying a value of 0.0 means there is no damping, in other words, people would say, "this has no physics, like Wing Commander." The more damping, the harder to control, but the more smoothly it moves.
*Syntax: ''Value''

===$Rotdamp:===
*Same thing, but for rotational movement.
*Syntax: ''Value''

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*Syntax: ''Value, Value, Value'', (meters per second) x-axis, y-axis, z-axis
**Example: ''0.0, 0.0, 80.0''

===$Rotation time:===
*Defines rotation times around the x, y, and z -axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis
*Syntax: ''Value, Value, Value'', (seconds per 360 degree turn) x-axis, y-axis, z-axis
**Example: ''3.0, 2.6, 5.0''

===$Rear Velocity:===
*Defines rear velocity
*Syntax: ''Value'', (meters per second) usually zero

===$Forward accel:===
*Number of seconds needed from full stop to maximum velocity
*Syntax: ''Value'', (seconds)

===$Forward decel:===
*Number of seconds needed from maxumum velocity to full stop
*Syntax: ''Value'', (seconds)

===$Slide accel: and $Slide decel:===
*Same for sliding as the $Forward accel: and $Forward decel: for normal movement.
*Syntax: ''Value'', (seconds) for both


===$Glide:===
*Allows gliding in game, i.e. turning the ship's facing without changing it's direction.
*Syntax: ''YES'' or ''NO''

===$Warpin type:===
*Allow an animation to be defined as a warpin effect.
*Syntax: ''Animation'' or ''default''

===$Warpin speed:===
*Sets the speed at which the ship warps in for default warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for animation type warpin effects
*Syntax: ''Value'', (meters per second or miiliseconds)

===$Warpin time:===
*Defines the effect duration
*Syntax: ''Value'' (milliseconds)

===$Warpin radius:===
*Defines the effect radius
*Syntax: ''Value'' (meters)

===$Warpin animation:===
*Defines the animation used as the warpin effect.
*Syntax: ''Filename''

===$Warpout type:===
*Allow an animation to be defined as a warpout effect.
*Syntax: ''Animation'' or ''default''

===$Warpout speed:===
*Sets the speed at which the ship warps out for default warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for animation type warpout effects
*Syntax: ''Value'', (meters per second or miiliseconds)

===$Warpout time:===
*Defines the effect duration
*Syntax: ''Value'' (milliseconds)

===$Warpout radius:===
*Defines the effect radius
*Syntax: ''Value'' (meters)

===$Warpout animation:===
*Defines the animation used as the warpout effect.
*Syntax: ''Filename''

===$Player warpout speed:===
*Sets the speed at which the player warps out from the game
*Syntax: ''Value'', can not be greater than $Max Oclk Speed:


===$Expl inner rad:===
*Radius at which the full explosion damage is done
*Syntax: ''Value'', (meters)

===$Expl outer rad:===
*Maximum radius at which any damage is done
*Syntax: ''Value'', (meters)

===$Expl damage:===
*Amount of damage done inside the inner radius
*Syntax: ''Value'', (damage value)

===$Expl blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: ''Value'', (blast effect)

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: ''YES'' or ''NO''


===$Shockwave Damage Type:===
*REQUIRES ADDITIONAL TABLE. Defines the damage type used for the ship explosions
*Syntax: ''Name'', as defined in armor.tbl


===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: ''Value'', (meters per second)

===$Shockwave count:===
*Defines the number of shockwaves to spawned
*Syntax: ''Value''


===$Shockwave model:===
*Defines the textured model used as the ship's shockwave
*Implemented before FS_Open 3.6.5
*Syntax: ''name.pof''

===$Shockwave name:===
*Defines the name of the animation to used for the shockwave
*Syntax: ''Name''

===$Weapon Model Draw Distance:===
*Distance that external weapons are shown, ie missiles and such.
*Syntax: ''Value'', (meters)
**Default: ''200''


===Primary Weapons===

====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes). Each of the primary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry. Implemented before FS_Open 3.6.5
*Syntax: ''( "Name" "Name" )''
*Syntax: ''( "Name" "Name" ) ( "Name" "Name" )''
**Example: ''( "Subach HL-7" "Prometheus R")''

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights. Each of the primary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry. 
*Syntax: ''( "Name" "Name" )''
*Syntax: ''( "Name" "Name" ) ( "Name" "Name" )''
**Example: ''( "Subach HL-D" "Prometheus D")''

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: ''( "Name" "Name" )''
**Example: ''( "Subach HL-7" "Prometheus R")''


====$PBank Capacity:====
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas. REQUIRES FLAG "ballistic primaries"
*Implemented before FS_Open 3.6.5
*Syntax: ''( Value, Value )'', usually all primary bank capacities are 1.
**Example: ''( 1, 1 )''

====$Show Primary Models:====
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: ''( YES'' or ''NO )''
**Example: ''( YES YES )''- Note the spaces on the insides of the brackets.


===Secondary Weapons===

====$Allowed SBanks:====
*Same for secondary weapons. Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry. Implemented before FS_Open 3.6.5
*Syntax: ''( "Name" "Name" )''
*Syntax: ''( "Name" "Name" ) ( "Name" "Name" )''
**Example: ''( "Harpoon" "Hornet")''

====$Allowed Dogfight SBanks:====
*Same for secondary weapons. Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry. 
*Syntax: ''( "Name" "Name" )''
*Syntax: ''( "Name" "Name" ) ( "Name" "Name" )''
**Example: ''( "Harpoon D" "Hornet D")''

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: ''( "Name" "Name" )''
**Example: ''( "Harpoon" "Hornet")''

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: ''( Value, Value )'', (ammo capacity)
**Example: ''( 40, 40 )''


====$Show Secondary Models:====
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: ''( YES'' or ''NO )''
**Example: ''(YES YES)''


===$Shields:===
*Determines the shield strenght
*Syntax: ''Value'', (total hitpoints in all quadrants together)

===$Shield Color:===
*RGB value for shield color
*Syntax: "Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
**Example: ''100, 100, 255''
**Default: ''255, 255, 255''

===$Power Output:===
*The amount of energy available. The higher the output, the faster your weapons recharge.
*Syntax: ''Value''

===$Max Oclk Speed:===
*Maximum velocity with all energy diverted to engines
*Syntax: ''Value'', (meters per second)

===$Max Weapon Eng:===
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: ''Value''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: ''Value'', (hitpoints)
**Default: ''100''


===$Hull Repair Rate:===
*Repair rates for hull at percent per second
*Syntax: ''Value'', % of hitpoints repaired per second

===$Subsystem Repair Rate:===
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', % of hitpoints repaired per second
**Default ''0.01'', that is 1 % per second

===$Armor Type===
*REQUIRES ADDITIONAL TABLE. Defines armor type used for the ship
*Syntax: ''Name'', as defined in armor.tbl


===$Flags:===
*See below
*Syntax: ''( "Flag" "Flag" )''
**Example: ( "fighter" "in tech database" )

===$AI Class:===
*Default AI class
*Syntax: ''AI name'', as defined in AI.tbl

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: ''YES'' or ''NO''
*'''+Aburn Max Vel:'''
**In same format as in $Max Velocity:
**Syntax: ''Value'', (meters per second)
*'''+Aburn For accel:'''
**Defined only as the forward acceleration. In same format as $Forward accel:
**Syntax: ''Value'', (seconds)
*'''+Aburn Fuel:'''
**Amount of afterburner fuel the ship has
**Syntax: ''Value'' (fuel units)
*'''+Aburn Burn Rate:'''
**Rate the fuel is consumed when afterburner is engaged (in units per seconds)
**Syntax: ''Value'' (fuel units per second)
*'''+Aburn Rec Rate:'''
**Rate the fuel is restored.
**Syntax: ''Value'' (fuel units per second)
*'''$Trails:'''
**Implemented before FS_Open 3.6.5
**Allows afterburner trails to be used
**'''+Bitmap:'''
***Texture used to draw the afterburner trail
***Syntax: ''Filename''
**'''+Width:'''
***Width of afterburner trail at the beginning of it (ie. the thruster end)
***Syntax: ''Value'', (in meters)
****Default: ''1.0''
**'''+Alpha:'''
***Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
***Syntax: ''Value''
****Default: ''1.0''
**'''+Life:'''
***How long the trail will last
***Syntax: ''Value'', (in seconds)
****Default: ''5.0''



===$Countermeasure Type:===
*Defines the weapon model used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: ''Name'', as defined in weapons.tbl


===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: ''Value''

===$Scan time:===
*Time it takes to scan the ship
*Syntax: ''Value'', (milliseconds)
**Default: ''2000''

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: ''Name'', where sound is the index or name of a sound in sounds.tbl

===$Closeup_pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: ''Value'', ''Value'', ''Value'', (X, Y and Z values)

===$Closeup_zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: ''Value'', (radians)


===$Topdown offset:===
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: ''Value'', (meters)


===$Shield_icon:===
*This .ani file must be at data/hud and included to the hud.tbl. Reference to the hud.tbl is no longer needed.
*Syntax: ''Filename''
**Example: ''shield-f01''

===$Ship_icon:===
*The icon used in ship selection. Ship model is used by default to generate the image.
*Syntax: ''Filename''
**Example: ''iconfighter01''

===$Ship_anim:===
*The glowing green grid animation used in ship selection. Ship model is used by default to generate the image.
*Syntax: ''Filename''
**Example: ''ssfighter01''

===$Ship_overhead:===
*The overhead view used in the weapons loadout. Ship model is used by default to generate the image.
*Syntax: ''Filename''
**Example: ''loadfighter01''

===$Score:===
*Points awarded for destroying the ship
*Syntax: ''Value'', (points)


===Customized Thruster Effects===
*Implemented before FS_Open 3.6.5
*'''Defines the primary thruster glow'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: ''Filename''
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: ''Filename''
**'''$Thruster01 Radius factor:'''
***Defines???
***Syntax: ''Value''
****Default: ''1.0''
*'''Defines the secondary glow type-effect for thrusters'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: ''Filename''
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: ''Filename''
**'''$Thruster02 Radius factor:'''
***Defines???
***Syntax: ''Value''
****Default: ''1.0''
**'''$Thruster01 Lenght factor:'''
***Defines???
***Syntax: ''Value''
*'''Defines the tertiary glow type-effect for thrusters'''
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: ''Filename''
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: ''Filename''
**'''$Thruster03 Radius factor:'''
***Defines???
***Syntax: ''Value''
****Default: ''1.0''

===$Thruster Particles:===
*Defines the alternative particle thruster
*Implemented before FS_Open 3.6.5
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to three can be defined for both standard thrusters and afterburners (6 in total). Afterburner particles require atleast 1 existing particle thruster entry.
**Syntax: ''Filename'', of ani file used
***Example: Exp04
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: ''Value'', (in meters)
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: ''Value'', (in meters)
*'''$Min created:'''
**Defines the minimum amount of particles created per second
**Syntax: ''Value'', (per second)
*'''$Max created:'''
**Defines the maximum amount of particles created per second
**Syntax: ''Value'', (per second)
*'''$Variance:'''
**Value that describes the randomnes or particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: ''Value'', (per second)


===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar. This field is deprectated, and mods using 3.6.8 and above should use the "stealth" flag.
*Syntax: None
**Default: Off


===$Max decals:===
*Defines: Maximum number of weapon decals on a ship
*Implemented before FS_Open 3.6.5
*Syntax: ''Number'', of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.


===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
*'''+Offset:'''
**The position of the contrail's head
**Syntax: ''Value'', ''Value'', ''Value'', (X, Y, Z values) relative to the centerpoint of the model
*'''+Start Width:'''
**The width of the contrail's head
**Syntax: ''Value'', (meters)
*'''+End Width:'''
**The width of the contrail's tail
**Syntax: ''Value'', (meters)
*'''+Start Alpha:'''
**The opacity of the contrail's head
**Syntax: ''Value'', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the contrail's tail
**Syntax: ''Value'', value between 0 and 1
*'''+Max Life:'''
**How long the contrail remains
**Syntax: ''Value'', (seconds)
*'''+Spew Time:'''
**????
**Syntax: ''Value'', (seconds)
*'''+Bitmap:'''
**The image to use for the contrail.
**Syntax: ''Filename''
***Example: Contrail01


===$Thruster:===
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manouvering thruster defined in this entry
**Syntax: ''Value''
*'''+Used for:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
*'''+Flags:'''
**Flags that modify thruster behavior. As of now, only "no scale" exists, which causes all thrusters to be displayed at the same size regardless of thrust amount.
**List of flags: no scale
**Syntax: ("''Name''")
*'''+Position:'''
**Defines thruster location
**Syntax: ( ''Value'' ''Value'' ''Value'' )
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( ''Value'' ''Value'' ''Value'')
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: ''Filename''
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: ''Value'', (meters)
*'''+Length:'''
**Defines the lenght of thruster trail
**Syntax: ''Value'', (meters)
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: ''Value'', (sounds.tbl reference)
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continously used
**Syntax: ''Value'', (sounds.tbl reference)
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: ''Value'', (sounds.tbl reference)


===[[Subsystems|$Subsystem:]]===

===Ships.tbl flags===

'''"no_collide"'''
*Defines ship as non-collideable, ie everything will go through it
'''"player_ship"'''
*Makes it possible to player to fly the ship
'''"default_player_ship"'''
*Makes this ship as a default part of the loadout options in FRED
'''"repair_rearm"''' OR '''"support"'''
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species
'''"cargo"'''
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders
'''"fighter"'''
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders
'''"bomber"'''
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders
'''"transport"'''
*Defines ship as a transport and also sets the AI behaviour
'''"freighter"'''
*Defines ship as a freighter and also sets the AI behaviour
'''"capital"'''
*Defines ship as a capital ship and also sets the AI behaviour
'''"supercap"''' OR '''"super cap"'''
*Defines ship as a super capital ship and also sets the AI behaviour
'''"drydock"'''
*Defines ship as a drydock and also sets the AI behaviour
'''"cruiser"'''
*Defines ship as a cruiser and also sets the AI behaviour
'''"navbuoy"'''
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders
'''"sentrygun"''' OR '''"sentry gun"'''
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders
'''"escapepod"''' OR '''"escape pod"'''
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

'''"stealth"'''
*Defines ship as a stealth-ship: non-targettable, and not on radar.

'''"no type"'''
*Does ???
'''"ship copy"'''
*Defines the ship as a copy of another model
'''"in tech database"'''
*Includes ships description to the tech database from the beginning of the campaign
'''"in tech database multi"'''
*Includes the ship to multiplayer tech database
'''"dont collide invisible"'''
*Defines invisible textures as non-collideable (For example, a hangar entrace)
'''"big damage"'''
*Limits the damage made to the ship by non-huge weapons.
'''"corvette"'''
*Defines ship as a corvette and also sets the AI behaviour
'''"gas miner"'''
*Defines ship as a gas miner and also sets the AI behaviour
'''"awacs"'''
*Defines ship as a AWACS and also sets the AI behaviour
'''"knossos"''' OR '''"knossos device"'''
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders
'''"no_fred"'''
*Ship will not appear in FRED.

'''"ballistic primaries"'''
*Enables the ship to use ballistic primaries
*Implemented before FS_Open 3.6.5
'''"flash"'''
*Makes a flash when a ship dies
*Implemented before FS_Open 3.6.5
'''"surface shields"'''
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.
'''"show ship"'''
*Will result in the player's ship model being rendered, when in cockpit mode
'''"generate icon"'''
*Creates a HUD icon from the model itself
'''"no weapon damage scaling"'''
*Disables bombs doing different damage to different ship types
'''"gun convergence"'''
*Enables ship to use the firingpoints' normals in defining the direction where the weapon fire


==Player Ship Precedence==
*Syntax: ( ''"Name" "Name"'')
*Example:

$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )

==Sample==

#Default Player Ship
$Name: GTF Ulysses
#End
#Engine Wash Info
$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0
#End
#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF file: fighter01.pof
$Detail distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward accel: 2.0
$Forward decel: 1.5
$Slide accel: 0.0
$Slide decel: 0.0
$Expl inner rad: 25.0
$Expl outer rad: 55.0
$Expl damage: 15.0
$Expl blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan time: 2000
$EngineSnd: 128
$Closeup_pos: 0.0, 0.0, -22
$Closeup_zoom: 0.5
$Shield_icon: shield-f01
$Ship_icon: iconfighter01
$Ship_anim: ssfighter01
$Ship_overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0
#End
$Player Ship Precedence: (
"GTF Ulysses")

[[Category:Tables]]

Source Code Project index

2007-01-11T08:41:37Z

WMCoolmon:

===Getting Started with the Source Code Project===

#[[FSSCP Introduction]]
#[[Getting Freespace]]
#Installing FSSCP
#*[[FreeSpace Open Installer]]
#*[[Installing fs2_open|Installing FreeSpace Open without the Installer]]
 
====Optional post-install====
[[Installing mods for fs2_open]]
 [[Troubleshooting]]
 [[Bug Reporting]]
 
====Errata====
[[FS2 Status Page]]
 [[FS2 data installation]]
 
 
===Getting Started with Development===
[[Coding In C]]
 [[Linux CVS Howto]]

[[Category:Source Code Project]]

Modular Tables

2006-10-09T06:27:50Z

WMCoolmon: Added muzzleflash to the tables list

Modular tables are SCP addition to the standard FreeSpace table system. XMTs (or eXtentable Modular Tables) offer capability to add new entries or alter already existing tables without any need of editing the 'parent' table file.

==Extendable Tables==
*[[ai_profiles.tbl]] can be extended with '''xxx-aip.tbm''' (XMT)
*[[armor.tbl]] can be extended with '''xxx-amr.tbm''' (non-XMT)
*[[mflash.tbl]] can be extended with '''xxx-mfl.tbm''' (non-XMT)
*[[hud_gauges.tbl]] can be extended with '''xxx-hdg.tbm''' (non-XMT)
*[[music.tbl]] can be extended with '''xxx-mus.tbm''' (non-XMT)
*[[ships.tbl]] can be extented with '''xxx-shp.tbm''' (XMT)
*[[species_defs.tbl]] can be extended with '''xxx-sdf.tbm''' (XMT)
*[[stars.tbl]] can be extended with '''xxx-str.tbm''' (non-XMT)
*[[weapons.tbl]] can be extended with '''xxx-wep.tbm''' (XMT)
*[[weapon_expl.tbl]] can be extended with '''xxx-wxp.tbm''' (non-XMT)

==Other Related Tables==
*[[fireball.tbl]] can be '''''edited''''' with '''xxx-fbl.tbm''' file ([[fireball.tbl#Modular Fireball Table|special]])

==Important Notes==
*Modular table files should use the 'parent table' files sections.
*Completely new entries and also complete rewrites of entries in parent table file are always possible.
*For '''xxx-shp.tbm''' and '''xxx-wep.tbm'''
**Table entries in modular tables do not have to be complete. Partial entries can be used to alter the data found in parent table files when only some changes to the original are desired to be made.
**Adding '''+nocreate''' right after the entry's name prevents possible creation of partially undefined entry. For example if the parent table file lacked the entry that was included to the as a partial entry to the modular table file then the creation of partially undefined entry is possible which could cause problems with the game.
***Example:

$Name: @Subach HL-7
+nocreate

==Sample - Alpha-wep.tbm==
*Changes the speed of the ''Subach HL-7'' and also adds a faint grey trail to it.
*To create it make a text file using a text editor and save the file as '''''Alpha-wep.tbm''''' with the following contents to the proper folder (.../data/tables).

#Primary Weapons
$Name: @Subach HL-7
+nocreate
$Velocity: 650.0
$Trail:
+Start Width: 0.4
+End Width: 0.0
+Start Alpha: 0.35
+End Alpha: 0.0
+Max Life: 0.2
+Bitmap: Contrail
#End

[[Category:Tables]]

Source Code Project index

2006-09-28T01:46:55Z

WMCoolmon:

===Getting Started with the Source Code Project===

[[FSSCP Introduction]]
 [[Getting Freespace]]
 [[Installing fs2_open]]
 [[FS2 data installation]]
 [[Installing mods for fs2_open]]
 [[Troubleshooting]]
 [[Bug Reporting]]
 [[FS2 Status Page]]

===Getting Started with Development===
 [[Coding In C]]
 [[Linux CVS Howto]]

[[Category:Source Code Project]]

FS2 Open Lua Scripting

2006-09-04T21:05:41Z

WMCoolmon:

This page is intended as a crash-course in Lua scripting as it relates to Freespace 2. It's only meant to get you started with Lua scripting - more advanced concepts such as metatables will not be covered.

You don't need to read the Appendices, but I recommend at least reading the "Optimizing" section if you're doing much scripting.

== What You Need ==
You will need a basic understanding of how to open and edit computer files, a copy of Freespace 2, and an open mind. Any kind of prior scripting experience will be immensely helpful, but you shouldn't need any to understand this document.

Here we go!

Note: Although all the examples should not cause syntax errors anywhere, they may not work in certain places. For example, you have to load a mission before you can get handles to ships in the mission.

== Scripting hooks ==
A scripting hook is a segment of Lua code, that is run at a specific place in FS2_Open. Some scripting hooks, such as $GameInit, are executed only once. Others, such as state hooks, are executed every frame. Others may be executed only when a specific action occurs (such as a keypress or a ship warping out).

There are three different types of hooks. All hooks are parsed and loaded into memory when they are read, so there is no speed difference. Also, the optional field "+Override: YES" can be used to make a scripting hook completely override fs2_open's usual behavior. (For example, for the HUD, this would completely disable the default fs2_open HUD and use the scripting version instead)

For the sake of organization, information on different scripting hooks can be found in the wiki page for the table that they are actually in.

=== Return hook ===
$Hook: 2 + Mission.getNumShips()
This works like a normal table variable, except that you can use scripting functions as well.

=== Normal hook ===
$Hook: [
gr.setColor(255, 255, 255)
gr.drawString("Hello, world!")

return 2 + Mission.getNumShips()
]
A normal hook is denoted by [ and ]. Whatever is within the brackets is passed to the Lua interpreter. This means that you cannot use table-style ;; comments within brackets; you must use Lua's comments.

However, you can still use it with a .tbl field that takes a value, using the "return" command. In this case, even though the other lines are still run, the $Hook: variable would be set to the same value as in the 'Return hook' example.

=== File hook ===
<pre>$Hook: [[script.lua]]</pre>
A file hook loads the scripting from the file in the data/scripts directory. In all other respects, it is the same as a normal hook.

== Comments ==
A "comment" (in any programming or scripting language) is a block of a script that is ignored. In Lua there is only one kind of comment, which starts with double-dashes. Any time you put two dashes in a Lua script outside of a string, the rest of the line will be ignored. (This is the same as putting a double-semicolon in a Freespace table)

For example, this:
--Load a mission for use in the mainhall
Mission.loadMission("sm2-10.fs2") --Use 'King's Gambit' for now.

Will do exactly the same thing as this:
Mission.loadMission("sm2-10.fs2")

== Variables ==
A variable is the simplest kind of thing that there is in Lua. All it really does is hold data; no more, no less. They really aren't that scary. Here are some different types of variables

--Number variable
life = 42

--String variable
name = "Bob"

--Boolean variables
smoking = true
healthy = false

--Userdata (Handle or object) variable
player = mn.getShipByName("Alpha 1")

--Nil variable
--Erases a previously set variable
life = nil

--Member variable of userdata. Can be any of the above types.
player.Name = "Ship"

Note: Although technically objects and handles are all userdata, it's easier to just think of every object and handle as being different types of variables.

=== Arrays ===

An array is a special type of variable, that holds multiple variables. The '''''index''''' of all Lua arrays starts at 1.

--Set the fifth element of array to 1
a[5] = 12
--Set n to the fifth element (tehe)
n = a[5]
--n will be 12

== Libraries ==
In order to gain access to the FS2_Open engine through scripting, you must use the FS2_Open libraries. Each library represents a different section of the engine. In addition, libraries may be referenced one of two ways: the full name, or a shorthand version of the name made up of two letters. Here, the same setColor '''''function''''' is used twice.

Graphics.setColor(255, 255, 255)
gr.setColor(255, 255, 255)

For the sake of easy reading, I've used the longhand version of names in the wiki. However, I recommend you learn the shorthand versions as they're generally faster to work with when scripting.

To get a full list of library functions, use the "-output_scripting" command line parameter. This should create a file called scripting.html, with a list of the different libraries, functions, and types supported by that build. (Use a web browser to open it)

== Functions ==
A function is an instruction to Lua to do something. It may change variables, or it may call (activate) other functions. Functions are the meat of scripting; they get everything done. Essentially, they are much like an individual SEXP.

As a result, this section is pretty tough, but covers almost all of the specific knowledge you'll need to work within Lua.

=== Function vocabulary ===
* '''''Return value''''' - Data that a function returns. Any data that a function returns may be stored in a variable.
* '''''Arguments''''' - Data that is given to a function. May be data itself, a variable containing the data, or even the return value of another function.
* '''''Call''''' - To run a function.

=== Typical function use ===
Example: This will write "Alpha 1" in the upper-left corner of the screen.
player = Mission.getShipByName("Alpha 1")
Graphics.setColor(255, 255, 255)
Graphics.drawString(player.Name, 5, 5)

* Line 1: In the first line, the "getShipByName" function of the mission library is run. Because "Alpha 1" is specified as the argument, the return value of the getShipByName function will be the ship handle of the ship named "Alpha 1" in the mission (or nil if Alpha 1 is dead or there was no Alpha 1 to begin with). Because the player variable is set to the function, it will take on the return value of the function. Result After the first line, the player variable is a ship handle to the ship named "Alpha 1" in the current mission.

* Line 2 In the second line, the "setColor" function is used to set the current drawing color to pure white. Unlike getShipByName, it takes at least three arguments, all numbers - the red, green, and blue scale of the current color, from 0 to 255. It's always a good idea to use the setColor function before doing any drawing in scripting, as the engine can and will change the current color between scripting hooks. Result Current drawing color is set to pure white

* Line 3 In the third line, the drawString function takes three arguments - a string, followed by two numbers. The string specifies the text to write, the numbers specify the x and y position of the upper-left corner of the written text. As you can see, we've directly used a '''''member variable''''' of the player variable to fill the first argument. Because we got the ship handle by its name, the Name variable will be the same as the name that we got it by ("Alpha 1"). Result After the third line, "Alpha 1" will appear in the upper-left corner of the string in white text.

Note: Numbers and certain types of userdata will automatically convert to strings. In all other cases, functions will give an error if you try to use the wrong type of argument.

Debugging note: If Alpha 1 were dead in the above example, you would get an error about 'trying to index a nil value' because it would not be able to run the getName() function.

=== Userdata functions ===
Handles and objects may also have functions.

Example: This will write the number of subsystem's on Alpha 1's ship in the upper-left corner.
player = Mission.getShipByName("Alpha 1")
Graphics.drawString(player:getNumSubsystems(), 5, 5)

As before, we get the handle to the Alpha 1 ship with getShipByName.

=== Optional arguments ===

Sometimes you don't have to use an argument. For example, the setColor function has an optional fourth argument - how opaque the color should be. If the argument isn't used, the color is totally opaque. These two lines do the same thing:

Graphics.setColor(255, 255, 255)
Graphics.setColor(255, 255, 255, 255)

== Quick, a full example! ==
By this point, you may be bored of all this exposition. So here's your typical "Hello, World!" example.

For this amazing trick, we'll make our very own splash screen. Turn off all Freespace 2 mods, and create a file called "scripting.tbl" in your data/tables directory. Open that up in a text editor, and write:
#Global Hooks
$Splash: [
--Set the color to white
Graphics.setColor(255, 255, 255)
--Write "Hello, world!"
Graphics.drawString("Hello, world!", 5, 10)
]
+Override: YES
#End

Now, when you start up FS2_Open, you should see "Hello, world!" in the upper-left, as it loads.

== Control structures ==
A control structure is a series of statements that let you change how a script runs, based on some condition - say, a ship is dead, or the life of a certain ship has fallen below a certain amount.

=== If statements ===
If statements are a way to check if something is some way or not. All if statements have the form:
if (something) then
(execute)
end

(something) can be true, or false. If it's true, then (execute) will be run. If it's false, then the script will skip down to "end" and go on from there.

To check that a handle is valid:
ship = Mission.getShipByName("Alpha 2")
if ship then
--This will always happen while Alpha 2 is alive
Graphics.drawString("MACKIE LIVES!", 5, 10)
end

To check a variable value
x = 42
y = 23
if x < y or x is y then
--We never get here, because x is bigger than y
end

=== For statements ===
A for statement is generally used to iterate through a list.

Example:
This bit of scripting will run through all of Alpha 2's subsystems if she isn't dead, and display a list of them in the upper-left.

ship = Mission.getShipByName("Alpha 2")
if ship then
num_subsys = ship:getNumSubsystems()
x = 5
y = 5
for i=1,num_subsys do
--Use the i variable to go through the ship's subsystems,
--and to change the y position of the text.
gr.drawString(ship[i]:getName(), x, y + i*10)
end
end

=== More information ===
For other keywords you can use with control structures, see the [http://www.lua.org/manual/5.0/manual.html#2.5.2 Lua Documentation]

For more detailed information on if statements and other types of control structures, see the [http://lua-users.org/wiki/ControlStructureTutorial Lua-users wiki]

== Appendices ==

There's more depth to scripting than what's covered above. To make the rest of the article shorter, I've put the topics still within the scope of this article, but not necessary to know in most cases, down here.

However, I HIGHLY recommend you read the optimizing scripting section.

=== Appendix: Optimizing scripting ===

Because fs2_open is written in C, which is much faster than Lua, it is much better to store variables in C and provide Lua functions to work with them. In addition, to keep Lua scripting from messing with C scripting and to make it as friendly as possible, there are a number of safeguards to catch problems, in most of the Lua functions.

As a result, whenever you're working with a value provided by a library or object function, you should set it to a Lua variable if you're going to use it more than 1-2 times due to the large overhead resulting from the interface.

Thus, even though it may [i]look[/i] like "Name" is a member variable of the ship handle, it is actually a function that performs 3-4 validity checks before returning the value, which must also be converted from C to Lua. Setting a variable to the return value of the function means that you can use that variable wherever you want to use the ship name using the native Lua environment.

=== Appendix: Debugging scripting ===

Unfortunately, the Lua interpreter provides only limited debugging information about hooks. (Supposedly, it will provide more information about scripting within user functions, but I haven't tested that claim yet)

Generally, error messages complaining about referencing or indexing a 'nil value' occur because a function could not return a handle, so it returned nil. Some functions also return false to indicate that the handle is correct, but due to some kind of wrong information being passed, it couldn't complete.

Generally, you should check all handles before using them:
player = getShipByName("Alpha 1")
if player then

end

With all uses of the player handle falling in the "if" statement.

=== Appendix: Function types ===

Here's all the different kinds of functions you can have:
--A function provided by itself
x = cos(y)
--A function provided by a library
x = Math.cos(y)
--A function provided by a userdata variable.
x = y:cos()
In every case, x would be set to the cosine of y, which is 1.

Note: You must use a ":" with userdata functions, as in the example. This tells Lua that it needs to give the function the value of the variable that it's being called from.

=== Appendix: Making your own functions ===
So, let's make the doSomething() function do, well, something.
doSomething = function()
color = "red"
end
As you can see, creating a function is much like creating a variable; you just use function() instead of the value, then write what you want the function to do. To end the function, you just write "end"

Now, let's use our new doSomething() function.
color = "black"
doSomething()
--After using doSomething(), color is now red

Functions can also '''''return''''' values.
--Make a new function
doSomethingElse = function()
return 10
end
x = 0
doSomething()
--x is now 27
x = doSomethingElse()
--x is now 10

=== Appendix: Variable Scope ===
The '''''scope''''' of a variable is the area where it exists. Writing <tt>local</tt> in front of the variable name will tell Lua that the variable should only exist within that function or hook.

Note that this means that if you use the same variable name in two different hooks without using local, the same variable will be used.

Note:

You may find it useful to have some way of distinguishing global variables from local ones, to remind yourself that the value does carry over. For example, starting global variable names with "g_".

Example: The following will draw the text "Media VP" in the upper-left corner of the main hall, even though the variable is set in a different hook than it is used in.

#Global Hooks
$GameInit: [g_mod = "Media VP"]
#End

#State Hooks
$State: GS_STATE_MAIN_MENU
$Hook: [Graphics.drawString(g_mod, 0, 0)]
#End

=== Appendix: Variable Types ===
Variables can hold different types of data. These basic types are:

==== Boolean ====
A boolean is a simple variable - it can be true, or false.
--It's Monday, and Dilbert is at the office
working = true
--Oops, he just opened Solitaire
working = false

==== Numbers ====
A number is any variable that holds (As you might've guessed) a number. A number will automatically convert into a string, if needed.
--A variable can be a whole number, like this
x = 5
--Or it can be a decimal value
x = 3.141592654
--Or you can divide two numbers for a fraction
x = 3/4

==== Strings ====
A string is a variable that holds a series of characters, and a character is any number, letter, or symbol on your keyboard (and then some). Basically, strings are the way that words and sentences are passed around in Lua.
--A cow says moo!
cow = "moo"
--A friend's name
friend = "Bob"
Note that actual string content is contained within double quotation marks, to mark it as a string.

==== nil ====
nil isn't really a variable type, but it is important. nil means that a variable doesn't hold anything. If you want to get rid of a variable, you just set it to be nil.

--Today I got a new dog
dog = "Spot"
--But then he ran away
dog = nil

Any time an error says that a variable is nil, it usually means that it doesn't exist (Double-check your spelling).

==== Userdata/objects ====
Objects (or "userdata", as they are known in Lua) is a variable that can contain other variables, or functions. Variables or functions within an object are known as "member variables" or "member functions".

--Assuming we have a my_car object, this will copy it to your_car
your_car = my_car
--Congratulations! But maybe you want to customize it?
--Note how I refer to the member variable, color
your_car.color = "Red"

==== Handles ====
A handle isn't technically a Lua type, but handles are used a lot in FS2_Open Lua scripting. Essentially, a handle is a variable that refers to a specific object; but doesn't actually contain that object's data. An example is the "shipclass" type; it doesn't actually contain the data in ships.tbl, it just serves to reference the ship class so that you can get and set data.
--Get the "GTF Ulysses" ship type
--For this, I use the function 'getShipclassByName'
ulysses = tb.getShipclassByName("GTF Ulysses")
--Now get rid of the handle
ulysses = nil
--Even though we've gotten rid of the handle, the Ulysses will still exist.

In situations where a handle variable is an object, you must set the entire variable at once; you cannot change elements of the array individually.
--So intead of this...
ship = mn.getShipByIndex(1)
ship.Position["y"] = 0

--You would go...
ship = mn.getShipByIndex(1)
pos = ship.Position["y"]
pos["y"] = 0
ship.Position = pos

=== Appendix: External Lua references ===
* [http://www.devmaster.net/articles/lua/lua1.php DevMaster.net - Lua Scripting 101]
* [http://www.lua.org/manual/5.1/ Official Lua 5.1 Reference Manual]
* [http://www.lua.org/pil/ Programming in Lua]
* [http://www.lua-users.org/ lua-users.org]

Feature Requests

2006-07-02T07:23:05Z

WMCoolmon:

This page is primarily to serve as a database for feature requests for the Source Code Project.

== New Requests ==

=== Toggleable subsystems ===
Support for subsystems that can be turned on and off (ie when 'off', act as though they never existed - are untargetable, leave behind no damage LOD, do not take damage, cannot be collided with, etc.) This would be useful for ships where someone might want to remove or swap a subsystem (ie fighter cockpits could have Terran and Vasudan versions).
* '''Supported By:''' Shadows of Lylat

=== Side Multipart Turrets ===
Support for fully rotating turrets on the sides of ships.
* '''Supported By:''' Battlestar Galactica, The Babylon Project, Wing Commander Saga, Nukemod - Children of Shiva

=== Gatling Turrets ===
Support for Gatling gun turrets, which work same as a regular multipart turret but has an extra subobject (child of the barel) that rotates while the turret is firing.
* '''Supported By:''' Nukemod - Children of Shiva

=== Submodel Animation Triggers & Upgrades ===
Trigger Requests:
* Subspace - Performs animation on entrance to supspace, and undoes when a ship comes out of subspace, and acts as a initial position if the "mission takes place in subspace" flag is set.
*Weapon Fire - Performs animation when weapon is fired and undoes it before the weapon can fire again.
*Sexp - Animation triggered by sexp.
*Flight Control - Triggered by the the activation, toggle or motion of a particular flight control.
Requested Upgrades:
*Support for "model-relative" movement in addition to "current submodel position-relitive" movement that already exists.
*Incremental movement - moves a submodel to the position indicated, but does not undo the motion.
*Glowpoint linking - Make it possible to activate/deactivate/toggel a certain bank/slot of glowpoint(s).
*Counter-rotate option - allow an object to inherit its parent's motion while counter-rotating, usefull for translation effect.
*Increase heirarchy depth instance limit to at least 10 levels of heirarchy.
*Simple linked animation support - Support for animations liked with flight controls and other variable setting ship controls, usefull for making animated cockpit controls, control surfaces, and thrust vectoring nozzels.
* '''Supported By:''' Nukemod - Children of Shiva, Twisted Infinities, Shadows of Lylat

=== 3D Muzzle Flashes ===
Support for pof based 3d muzzel flashes. perhaps also add variables for scale factor and fade speed.
* '''Supported By:''' Nukemod - Children of Shiva

=== Arrays and Other Collections ===
Support for FRED using arrays or other collections (or both) in a similar fashion to variables as there is currently no way to directly associate two variables with each other. Obviously some way to search the collection for a certain value would be needed.
* '''Supported By:''' MindGames, The Babylon Project, Twisted Infinities

=== Warping Without Vortex ===
Adds another checkbox to the arrival and departure cues for ships and wings, to disable rendering of the warp vortex, but will preserve all other aspescts of conventional warping, such as the arrival/departure speeds and deceleration/accelleration. Current option to disable warp rendering, will cause ship to appear and disappear without movement.
* '''Supported By:''' The Babylon Project

=== Convergence Firing ===
Also called "X-Firing", allows a weapon to have secondary source effects so that a weapon can appear to gain a charge boost from converging fire from other sources on the model. Could be either a beam or a standard primary. Would require additional data in the weapon table entry, for effects to be used and timing of the secondary prior to the main firing sequence, as well as data on the turret entry in the ships table, indicating co-ords for where the secondary effects will originate, and the number of secondary sources.
* '''Supported By:''' The Babylon Project

== In Progress ==
=== Customizable ship types ===
Add a new table (or an addendum to ships.tbl) that would allow modders to turn on and off individual aspects of ship types, as well as define new ones. Type should be settable in the $Flags: variable, just as it is now, and the :V: defaults should be integrated so that they may be overriden by mods.
* '''Supported By:''' The Babylon Project, Twisted Infinities

== Implemented ==
=== Flak Screen ===
Ability to set detonation range/time for flak shots so that flak weapons could fire at approaching ships beyond their 'detonation range' thus generating a flak screen in front of the approaching ships with the flak explosions. Preferably with little variance in the exact detonation time as there is always a little variance in normal flak explosions. Beams already support this sort of firing with +range: option. 
[[User:Wanderer|Wanderer]] 10:56, 9 Dec 2005 (GMT)
* '''Supported By:''' The Apocalypse Project

=== Submodel Animation Triggers & Upgrades ===
*Afterburners - Performs animation when afterburners are used and undoes the anumation when they go off.
*Turret Fire - Performs animation when a particular turret is fired and undoes it before the turret can fire again.

=== Muzzle Flashes and Turrets ===
Extented support for muzzle flashes so that all turreted weapons could use the muzzle flashes.
* '''Supported By:''' Starfox mod, Twisted Infinities

Feature Requests

2006-07-02T07:21:59Z

WMCoolmon:

This page is primarily to serve as a database for feature requests for the Source Code Project.

== New Requests ==

=== Toggleable subsystems ===
Support for subsystems that can be turned on and off (ie when 'off', act as though they never existed - are untargetable, leave behind no damage LOD, do not take damage, cannot be collided with, etc.) This would be useful for ships where someone might want to remove or swap a subsystem (ie fighter cockpits could have Terran and Vasudan versions).
* '''Supported By:''' Shadows of Lylat

=== Side Multipart Turrets ===
Support for fully rotating turrets on the sides of ships.
* '''Supported By:''' Battlestar Galactica, The Babylon Project, Wing Commander Saga, Nukemod - Children of Shiva

=== Gatling Turrets ===
Support for Gatling gun turrets, which work same as a regular multipart turret but has an extra subobject (child of the barel) that rotates while the turret is firing.
* '''Supported By:''' Nukemod - Children of Shiva

=== Submodel Animation Triggers & Upgrades ===
Trigger Requests:
* Subspace - Performs animation on entrance to supspace, and undoes when a ship comes out of subspace, and acts as a initial position if the "mission takes place in subspace" flag is set.
*Weapon Fire - Performs animation when weapon is fired and undoes it before the weapon can fire again.
*Sexp - Animation triggered by sexp.
*Flight Control - Triggered by the the activation, toggle or motion of a particular flight control.
Requested Upgrades:
*Support for "model-relative" movement in addition to "current submodel position-relitive" movement that already exists.
*Incremental movement - moves a submodel to the position indicated, but does not undo the motion.
*Glowpoint linking - Make it possible to activate/deactivate/toggel a certain bank/slot of glowpoint(s).
*Counter-rotate option - allow an object to inherit its parent's motion while counter-rotating, usefull for translation effect.
*Increase heirarchy depth instance limit to at least 10 levels of heirarchy.
*Simple linked animation support - Support for animations liked with flight controls and other variable setting ship controls, usefull for making animated cockpit controls, control surfaces, and thrust vectoring nozzels.
* '''Supported By:''' Nukemod - Children of Shiva, Twisted Infinities, Shadows of Lylat

=== 3D Muzzle Flashes ===
Support for pof based 3d muzzel flashes. perhaps also add variables for scale factor and fade speed.
* '''Supported By:''' Nukemod - Children of Shiva

=== Arrays and Other Collections ===
Support for FRED using arrays or other collections (or both) in a similar fashion to variables as there is currently no way to directly associate two variables with each other. Obviously some way to search the collection for a certain value would be needed.
* '''Supported By:''' MindGames, The Babylon Project, Twisted Infinities

=== Muzzle Flashes and Turrets ===
Extented support for muzzle flashes so that all turreted weapons could use the muzzle flashes.
* '''Supported By:''' Starfox mod, Twisted Infinities

=== Warping Without Vortex ===
Adds another checkbox to the arrival and departure cues for ships and wings, to disable rendering of the warp vortex, but will preserve all other aspescts of conventional warping, such as the arrival/departure speeds and deceleration/accelleration. Current option to disable warp rendering, will cause ship to appear and disappear without movement.
* '''Supported By:''' The Babylon Project

=== Convergence Firing ===
Also called "X-Firing", allows a weapon to have secondary source effects so that a weapon can appear to gain a charge boost from converging fire from other sources on the model. Could be either a beam or a standard primary. Would require additional data in the weapon table entry, for effects to be used and timing of the secondary prior to the main firing sequence, as well as data on the turret entry in the ships table, indicating co-ords for where the secondary effects will originate, and the number of secondary sources.
* '''Supported By:''' The Babylon Project

== In Progress ==
=== Customizable ship types ===
Add a new table (or an addendum to ships.tbl) that would allow modders to turn on and off individual aspects of ship types, as well as define new ones. Type should be settable in the $Flags: variable, just as it is now, and the :V: defaults should be integrated so that they may be overriden by mods.
* '''Supported By:''' The Babylon Project, Twisted Infinities

== Implemented ==
=== Flak Screen ===
Ability to set detonation range/time for flak shots so that flak weapons could fire at approaching ships beyond their 'detonation range' thus generating a flak screen in front of the approaching ships with the flak explosions. Preferably with little variance in the exact detonation time as there is always a little variance in normal flak explosions. Beams already support this sort of firing with +range: option. 
[[User:Wanderer|Wanderer]] 10:56, 9 Dec 2005 (GMT)
* '''Supported By:''' The Apocalypse Project

=== Submodel Animation Triggers & Upgrades ===
*Afterburners - Performs animation when afterburners are used and undoes the anumation when they go off.
*Turret Fire - Performs animation when a particular turret is fired and undoes it before the turret can fire again.

Script - Example HUD

2006-07-01T04:12:02Z

WMCoolmon:

{{captionedimage|image=[[image:Script-hudexample.jpg|thumbnail|320px]]|caption=Partial HUD created with scripting}}
==Function==
Creates new HUD or rather an example of scripted HUD. (Original source by [[User:WMCoolmon|WMCoolmon]])

==Table Entry==

===Scripting.tbl===
<pre>#Global Hooks
$GameInit: [[init.lua]]
$HUD: [[hud.lua]]
+Override: YES
#End</pre>

===init.lua===
<pre>--#################### HUD ####################--
drawBevRect = function(x1, y1, x2, y2)
-------Draw background
gr.setColor(0, 0, 48)
for x=1,5 do
--"/ \"
gr.drawLine(x1+(5-x), y1+x, x2-(5-x), y1+x)
--"\ /"
gr.drawLine(x1+(5-x), y2-x, x2-(5-x), y2-x)
end
-- "| |"
gr.drawRectangle(x1+1, y1+5, x2, y2-6, true)

-------Draw lines
gr.setColor(0, 128, 255)
--" - "
gr.drawLine(x1+5, y1, x2-6, y1)
--"/ \"
gr.drawLine(x1, y1+5, x1+5, y1)
gr.drawLine(x2, y1+5, x2-5, y1)
--"| |"
gr.drawLine(x1, y1+5, x1, y2-5)
gr.drawLine(x2, y1+5, x2, y2-5)
--"\ /"
gr.drawLine(x1, y2-5, x1+5, y2)
gr.drawLine(x2, y2-5, x2-5, y2)
--" - "
gr.drawLine(x1+5, y2, x2-6, y2)
end

setDamageColor = function(dcm)
local r
local g
local b
if dcm > .5 then
r = 255 * math.sin(dcm*math.pi)
g = 128+128 * math.sin(dcm*math.pi)
b = -255 * math.cos(2*dcm*math.pi)
else
r = 255
g = 255 * math.sin(dcm*math.pi)
b = 0
end

gr.setColor(r, g, b)
end</pre>

===hud.lua===
<pre>if slf then
-------Draw speed
x = 50
y = 50

drawBevRect(x, y, x+100, y+30)

local vel = slf.Orientation:rotateVector(slf.Velocity)
local mvel = slf.MaxVelocity

--Skip beveled area
x = x+5
y = y+5

--Draw X component
local speed = (vel.x/mvel.x)*10
gr.drawRectangle(x, y+5, x+20, y+15, false)
gr.drawRectangle(x+10, y+5, x+10+speed, y+15)

--Skip last gauge(20 px)
x = x+20+5

--Draw Y component
local speed = (vel.y/mvel.y)*10
gr.drawRectangle(x, y, x+10, y+20, false)
gr.drawRectangle(x, y+15, x+10, y+15+speed)

--Skip last gauge(10 px)
x=x+10+5

--Draw Z component
local speed = (vel.z/mvel.z)*50
gr.drawRectangle(x, y+5, x+50, y+15, false)
gr.drawRectangle(x, y+5, x+speed, y+15)

-------Draw life
x = 25
y = 200

drawBevRect(x, y, x+20, y+110)

x = x+5
y = y+5

dcm = slf.HitpointsLeft/slf.HitpointsMax

--Draw bar
gr.drawRectangle(x, y, x+10, y+100, false)
setDamageColor(dcm)
gr.drawRectangle(x, y+(1-dcm)*100, x+10, y+100)

-------Draw mission time
x = gr.getScreenWidth()-125
y = 200

drawBevRect(x, y, x+100, y+20)

x = x+5
y = y+5

gr.drawString("Flight time: ", x, y)

-------Draw gun ammo
x = 25
y = gr.getScreenHeight()-45

local pbank = slf.PrimaryBanks[1]

if pbank then
local ammo = pbank.AmmoLeft/pbank.AmmoMax*70

drawBevRect(x, y, x+120, y+20)

--Skip beveled area
x = x+5
y = y+5

--Draw bar
gr.drawRectangle(x, y, x+70, y+10, false)
gr.drawRectangle(x, y, x+ammo, y+10)

--Skip bar(70px)
x = x+70+5

--Draw number
gr.drawString(pbank.AmmoLeft, x, y)
end

-------Draw missile ammo
x = gr.getScreenWidth()-190
y = gr.getScreenHeight()-45

local sbank = slf.SecondaryBanks[1]

if sbank then
local sb_left = sbank.AmmoLeft
local sb_max = sbank.AmmoMax

drawBevRect(x, y, x+165, y+20)

x = x+5
y = y+5

for i = 1,16 do
if i > sb_max then
break
elseif i > sb_left then
gr.drawRectangle(x, y, x+5, y+10, false)
else
gr.drawRectangle(x, y, x+5, y+10)
end

x = x+10
end
end

-------Draw countermeasures
x = (gr.getScreenWidth()/2)-(105/2)
y = gr.getScreenHeight()-40

local cm_max = slf.Class.CountermeasuresMax

if cm_max then
local cm_left = slf.CountermeasuresLeft
drawBevRect(x, y, x+105, y+15)

x = x+5
y = y+5

for i = 1,10 do
if i > cm_max then
break
elseif i > cm_left then
--"-"
gr.drawLine(x+2, y+2, x+3, y+2)
--"|"
gr.drawLine(x+2, y+2, x+2, y+3)
else
--"-"
gr.drawLine(x, y+2, x+5, y+2)
--"|"
gr.drawLine(x+2, y, x+2, y+5)
--"\"
gr.drawLine(x, y, x+5, y+5)
--"/"
gr.drawLine(x, y+5, x+5, y)
end

x = x+10
end
end

--/slf
end</pre>

[[Category:Scripting Examples|Example HUD]]

File:Script-hudexample.jpg

2006-07-01T04:10:07Z

WMCoolmon: Screenshot of a partial HUD created using scripting.

Screenshot of a partial HUD created using scripting.

Template:Captionedimage

2006-07-01T04:06:18Z

WMCoolmon:

{| border=0 align=right cellpadding=0 cellspacing=0 width=30% style="margin: 0 0 1em 1em; background: #101010; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! style="color: white; height: 30px; background: #1B0E0E; 70%;"| {{{image}}}
|-
! style="color: white; height: 30px; background: #302020; 70%; align:center"| {{{caption}}}
|}

User:WMCoolmon

2006-07-01T04:04:14Z

WMCoolmon:

Within the Freespace community, I'm one of the Source Code Project coders. I've implemented a number of features, of which possibly the most notable are [[Modular Tables]] and the [[FS2_Open Lua Scripting|Lua scripting system]].

I've done some writing already for the wiki, and it tends to be pretty varied and (hopefully) informative.

Objecttypes.tbl

2006-06-20T06:34:25Z

WMCoolmon: Experimenting with image on a TBL page

{{shipimage|image=[[image:objecttypes.gif|thumbnail|320px]]|caption=objecttypes.tbl in action}}

Objecttypes.tbl is a table added by the FSSCP, used to set attributes of different object types. Currently the only section of this table are ship type attributes. A ship 'type' supercedes ship classes defined in ships.tbl. For example, the [[GTF Perseus]] and [[GTF Ulysses]] belong to the 'fighter' ship type. However, the [[GTD Orion]] belongs to the 'capital' ship type.

Note that objecttypes.tbl is fully XMT-compliant, with the suffix *-obt.tbm. In addition, the retail hardcoded types are being ported over to the objecttypes.tbl via an in-code table. So if a mod wishes to expand on the original types rather than replace them entirely, it should use a modular table file rather than a normal .tbl. Otherwise the in-code table will be ignored in favor of the one included in the mod, and the retail types will not be loaded (unless the mod includes them in its .tbl)

Note that a number of aspects of the retail types are still hardcoded, although they may be moved to the objecttypes.tbl if a mod requests it.

==General Format==
==#Ship Types==
===$Name:===
* Name of ship type. To assign a ship class to a given type, simply place the name entered here in the ship class's "$Flags:" field.

===$Counts for Alone:===
* Whether ship counts for determing whether or not Freespace 2 will play the "No reinforcements are available" message.
* Syntax: ''Yes/No''

===$Praise Destruction:===
* Whether wingmates will praise destruction of the ship.
* Syntax: ''Yes/No''

===$On Hotkey List:===
* Whether ship will show up in hotkey screen.
* Syntax: ''Yes/No''

===$Target as Threat:===
* Whether ship will be targetted with the 'H' key.
* Syntax: ''Yes/No''

===$Scannable:===
* Toggles whether ship type can be scanned
* Syntax: ''Yes/No''

===$Warp Pushes:===
* Whether ship will push other (pushable) ships out of the way while warping.
* Syntax: ''Yes/No''

===$Warp Pushable:===
* Whether ship can be pushed out of the way by ships with Warp Pushes enabled
* Syntax: ''Yes/No''

===$Max Debris Speed:===
* Maximum speed of debris spawned from ship
* Syntax: ''Number or decimal''

===$FF Multiplier:===
* Friendly-fire damage to ship will be multiplied by this amount
* Syntax: ''Number or decimal''

===$EMP Multiplier:===
* EMP effect will be multiplied by this amount. Higher values mean more HUD jittering/longer-lasting effect.
* Syntax: ''Number or decimal''

===$Beams Easily Hit:===
* Whether beams can easily hit ship (eg capship beams rarely hit fighters)
* Syntax: ''Yes/No''

===$Fog:===
====+Start Dist:====
* Distance from camera that fogging effect will start
* Syntax: ''Number or decimal''

====+Compl Dist:====
* Distance from camera that this object will be completely obscured by the fogging effect
* Syntax: ''Number or decimal''

===$AI:===
====+Valid Goals:====
* Valid goals that can be given to this object.
* Syntax: ''( "goal" "goal" )''
* '''Goals:'''
** attack ship
** dock
** waypoints
** waypoints once
** depart
** attack subsys
** form on wing
** undock
** attack wing
** guard ship
** disable ship
** disarm ship
** attack any
** ignore ship
** ignore ship (new)
** guard wing
** evade ship
** stay near ship
** keep safe dist
** rearm ship
** stay still
** play dead
** attack weapon
** fly to ship

====+Accept Player Orders:====
* Whether or not ship type will accept orders from player
* Syntax: ''Yes/No''

====+Player Orders:====
* Orders that ship type will accept from player
* Syntax: ''( "goal" "goal" )''
* '''Orders:'''
** attack ship
** disable ship
** disarm ship
** disable subsys
** guard ship
** ignore ship
** form on wing
** cover me
** attack any
** depart
** dock
** rearm me
** abort rearm
** stay near me
** stay near ship
** keep safe dist

====+Auto Attacks:====
* Whether or not ship type will auto attack nearby ships
* Syntax: ''Yes/No''

====+Attempt Broadsides:====
* Whether or not ship type will try to use broadside tactics against enemy ships
* Syntax: ''Yes/No''

====+Actively Pursues:====
* Which ship types the current ship type will actively pursue (rather than simply return to guard position or whatnot)
* Syntax: ''( "type" "type" )''

====+Guards Attack this:====
* Whether ships assigned to guard another ship will attempt to engage ships of the type
* Syntax: ''Yes/No''

====+Turrets Attack This:====
* Whether or not turrets will target the ships of the type
* Syntax: ''Yes/No''

====+Can Form Wing:====
* Whether or not ship type can be formed into a wing
* Syntax: ''Yes/No''

====+Active Docks:====
* Preferred docking bay type for ship when it is initiating the dock with another ship
* Syntax: ''( "bay" "bay" )''
* '''Dock bays:'''
** cargo
** rearm
** generic

====+Passive Docks:====
* Preferred docking bay type for ship when it is receiving a dock from another ship
* Syntax: ''( "bay" "bay" )''
* '''Dock bays:'''
** cargo
** rearm
** generic

==#End==

==Examples==

===Default FreeSpace 2 Table===
*This version of table won't work on builds before June 7th.
*Shiptypes '''Stealth''' and '''Fighter/Bomber''' do not seem to be used
<pre>
$Name: Navbuoy
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 10.0
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Actively Pursues: ( "navbuoy"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Turrets attack this: YES

$Name: sentrygun
$Counts for Alone: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 200
$FF Multiplier: 0.10
$EMP Multiplier: 10.0
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
+Disappear factor: 1.5
$AI:
+Accept Player Orders: NO
+Auto attacks: YES
+Actively Pursues: ( "navbuoy"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES

$Name: escapepod
$Praise Destruction: YES
$On Hotkey List: YES
$Warp Pushable: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 10.0
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
+Disappear factor: 1.5
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"attack wing"
"dock"
"waypoints"
"waypoints once"
"depart"
"undock"
"stay still"
"play dead"
"stay near ship" )
+Actively Pursues: ( "navbuoy"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Turrets attack this: YES

$Name: Cargo
$Scannable: YES
$Max Debris Speed: 200
$FF Multiplier: 0.10
$EMP Multiplier: 10.0
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
+Disappear factor: 1.5
$AI:
+Passive docks: ( "cargo" )

$Name: repair_rearm
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 3.5
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
+Disappear factor: 1.5
$AI:
+Valid goals: ( "fly to ship"
"dock"
"undock"
"waypoints"
"waypoints once"
"stay near ship"
"keep safe dist"
"stay still"
"play dead" )
+Accept Player Orders: YES
+Player orders: ( "rearm me"
"abort rearm"
"stay near me"
"stay near ship"
"keep safe dist"
"depart" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Active docks: ( "support" )

$Name: Stealth
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
+Disappear factor: 1.5
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"waypoints"
"waypoints once"
"depart"
"attack subsys"
"attack wing"
"guard ship"
"disable ship"
"disarm ship"
"attack any"
"ignore ship"
"ignore ship (new)"
"guard wing"
"evade ship"
"stay still"
"play dead"
"stay near ship"
"keep safe dist" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"disable ship"
"disarm ship"
"guard ship"
"ignore ship"
"ignore ship (new)"
"form on wing"
"cover me"
"attack any"
"depart"
"disable subsys\" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos\" )
+Guards attack this: YES
+Turrets attack this: YES
+Passive docks: ( "support" )

$Name: Fighter
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
+Disappear factor: 1.5
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"waypoints"
"waypoints once"
"depart"
"attack subsys"
"attack wing"
"guard ship"
"disable ship"
"disarm ship"
"attack any"
"ignore ship"
"ignore ship (new)"
"guard wing"
"evade ship"
"stay still"
"play dead"
"stay near ship"
"keep safe dist" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"disable ship"
"disarm ship"
"guard ship"
"ignore ship"
"ignore ship (new)"
"form on wing"
"cover me"
"attack any"
"depart"
"disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )

$Name: Bomber
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
+Disappear factor: 1.5
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"waypoints"
"waypoints once"
"depart"
"attack subsys"
"attack wing"
"guard ship"
"disable ship"
"disarm ship"
"attack any"
"ignore ship"
"ignore ship (new)"
"guard wing"
"evade ship"
"stay still"
"play dead"
"stay near ship"
"keep safe dist" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"disable ship"
"disarm ship"
"guard ship"
"ignore ship"
"ignore ship (new)"
"form on wing"
"cover me"
"attack any"
"depart"
"disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )

$Name: Fighter/bomber
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
+Disappear factor: 1.5
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"waypoints"
"waypoints once"
"depart"
"attack subsys"
"attack wing"
"guard ship"
"disable ship"
"disarm ship"
"attack any"
"ignore ship"
"ignore ship (new)" "guard wing"
"evade ship"
"stay still"
"play dead"
"stay near ship"
"keep safe dist" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"disable ship"
"disarm ship"
"guard ship"
"ignore ship"
"ignore ship (new)"
"form on wing"
"cover me"
"attack any"
"depart"
"disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )

$Name: Transport
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 2.0
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
+Disappear factor: 2.0
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"attack wing"
"dock"
"waypoints"
"waypoints once"
"depart"
"undock"
"stay still"
"play dead"
"stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"dock"
"depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )

$Name: Freighter
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Scannable: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 1.75
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
+Disappear factor: 2.0
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"attack wing"
"dock"
"waypoints"
"waypoints once"
"depart"
"undock"
"stay still"
"play dead"
"stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"dock"
"depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Active docks: ( "cargo" )
+Passive docks: ( "support" )

$Name: AWACS
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 0.8
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
+Disappear factor: 2.0
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"attack wing"
"dock"
"waypoints"
"waypoints once"
"depart"
"undock"
"stay still"
"play dead"
"stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )

$Name: Gas Miner
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 1.0
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
+Disappear factor: 2.0
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"attack wing"
"dock"
"waypoints"
"waypoints once"
"depart"
"undock"
"stay still"
"play dead"
"stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )

$Name: Cruiser
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 0.9
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
+Disappear factor: 2.0
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"attack wing"
"dock"
"waypoints"
"waypoints once"
"depart"
"undock"
"stay still"
"play dead"
"stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )

$Name: Corvette
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 0.3333
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
+Disappear factor: 2.0
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"attack wing"
"dock"
"waypoints"
"waypoints once"
"depart"
"undock"
"stay still"
"play dead"
"stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "depart\" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )

$Name: Capital
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushes: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.2
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 750.0
+Disappear factor: 3.0
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"attack wing"
"waypoints"
"waypoints once"
"depart"
"stay still"
"play dead"
"stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )

$Name: Supercap
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushes: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.075
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 1000.0
+Disappear factor: 3.0
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"attack wing"
"waypoints"
"waypoints once"
"depart"
"stay still"
"play dead"
"stay near ship" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )

$Name: Drydock
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.5
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 750.0
+Disappear factor: 3.0
$AI:
+Accept Player Orders: YES
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Passive docks: ( "support" )

$Name: Knossos
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.10
$Fog:
+Start dist: 10.0
+Compl dist: 1000.0
+Disappear factor: 3.0
$AI:
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Passive docks: ( "support" )</pre>

[[Category: Tables]]

Script - Ship Viewer

2006-06-18T07:38:40Z

WMCoolmon: Updated to take into account "+Override: true" change

==Function==
Prevents game itself from loading but instead loads a ship viewer. 
Moving mouse cursor with mouse botton pressed to:
{|
| width=150px|Upper left corner
| width=150px|Goes to next ship
|-
|Upper right corner
|Zooms in
|-
|Lower left corner
|Exits
|-
|Lower right corner
|Zooms out
|-
|}

==Table Entry==
<pre>#State Hooks
$State: GS_STATE_INITIAL_PLAYER_SELECT
$Hook: [
--Set default values
if not rotate_pct then
rotate_pct = 40
end

if not pitch then
pitch = 0
end

if not bank then
bank = 0
end

if not count then
count = 1
end

if not zoom then
zoom = 1.3
end

--Figure out if we need to check for triggers
--upper-left:#1 Goes to next ship
--upper-right:#2 Zooms in
--lower-left:#3 Quits
--lower-right:#4 Zooms out
if ms.getX() == 0 and ms.getY() == 0 then
trig = 1
elseif ms.getX()==(gr.getScreenWidth()-1) and ms.getY()==0 then
trig = 2
elseif ms.getX()==0 and ms.getY()==(gr.getScreenHeight()-1) then
trig = 3
elseif ms.getX()==(gr.getScreenWidth()-1) and ms.getY()==(gr.getScreenHeight()-1) then
trig = 4
else
trig = 0
end

--Do we need to activate trigger?
--Make sure that if the mouse is held down for
--more than one frame, trigger doesn't activate multiple times
if trig>0 then
if not middle_was_down then
middle_was_down = ms.isButtonDown("Left")
activate_trig = middle_was_down
elseif ms.isButtonDown("Left")==true then
middle_was_down = true
activate_trig = false
else
middle_was_down = false
activate_trig = false
end
else
middle_was_down = false
activate_trig = false
end

--Do trigger actions
if activate_trig then
if trig==1 then
count = count + 1
if count > tb.getNumShipClasses() then
count = 1
end
elseif trig==2 then
zoom = zoom-0.1
elseif trig==3 then
ba.setEvent("GS_EVENT_QUIT_GAME")
elseif trig==4 then
zoom = zoom+0.1
end
end

--If no triggers, do normal mouse stuff
--Left changes heading
--Middle changes pitch
--Right changes bank
if trig==0 then
if ms.isButtonDown("Left") then
rotate_pct = (1-ms.getX()/gr.getScreenWidth())*100
end
if ms.isButtonDown("Middle") then
pitch = (1-ms.getY()/gr.getScreenHeight())*100
end
if ms.isButtonDown("Right") then
bank = ms.getX()/gr.getScreenWidth()*100
end
end

--Finally, render the ship
render_ship = tb.getShipClassByIndex(count)
render_ship:renderTechModel(0, 0, gr.getScreenWidth()-1, gr.getScreenHeight()-1, rotate_pct, pitch, bank, zoom)
]
+Override: true
#End</pre>

[[Category:Scripting Examples|Ship Viewer]]

Objecttypes.tbl

2006-04-23T06:22:04Z

WMCoolmon:

Objecttypes.tbl is a table added by the FSSCP, used to set attributes of different object types. Currently the only section of this table are ship type attributes. A ship 'type' supercedes ship classes defined in ships.tbl. For example, the [[GTF Perseus]] and [[GTF Ulysses]] belong to the 'fighter' ship type. However, the [[GTD Orion]] belongs to the 'capital' ship type.

Note that objecttypes.tbl is fully XMT-compliant, with the suffix *-obt.tbm. In addition, the retail hardcoded types are being ported over to the objecttypes.tbl via an in-code table. So if a mod wishes to expand on the original types rather than replace them entirely, it should use a modular table file rather than a normal .tbl. Otherwise the in-code table will be ignored in favor of the one included in the mod, and the retail types will not be loaded (unless the mod includes them in its .tbl)

Note that a number of aspects of the retail types are still hardcoded, although they may be moved to the objecttypes.tbl if a mod requests it.

==General Format==
==#Ship Types==
===$Name:===
* Name of ship type. To assign a ship class to a given type, simply place the name entered here in the ship class's "$Flags:" field.

===$Counts for Alone:===
* Whether ship counts for determing whether or not Freespace 2 will play the "No reinforcements are available" message.
* Syntax: ''Yes/No''

===$Praise Destruction:===
* Whether wingmates will praise destruction of the ship.
* Syntax: ''Yes/No''

===$On Hotkey List:===
* Whether ship will show up in hotkey screen.
* Syntax: ''Yes/No''

===$Target as Threat:===
* Whether ship will be targetted with the 'H' key.
* Syntax: ''Yes/No''

===$Scannable:===
* Toggles whether ship type can be scanned
* Syntax: ''Yes/No''

===$Warp Pushes:===
* Whether ship will push other (pushable) ships out of the way while warping.
* Syntax: ''Yes/No''

===$Warp Pushable:===
* Whether ship can be pushed out of the way by ships with Warp Pushes enabled
* Syntax: ''Yes/No''

===$Max Debris Speed:===
* Maximum speed of debris spawned from ship
* Syntax: ''Number or decimal''

===$FF Multiplier:===
* Friendly-fire damage to ship will be multiplied by this amount
* Syntax: ''Number or decimal''

===$EMP Multiplier:===
* EMP effect will be multiplied by this amount. Higher values mean more HUD jittering/longer-lasting effect.
* Syntax: ''Number or decimal''

===$Beams Easily Hit:===
* Whether beams can easily hit ship (eg capship beams rarely hit fighters)
* Syntax: ''Yes/No''

===$Fog:===
====+Start Dist:====
* Distance from camera that fogging effect will start
* Syntax: ''Number or decimal''

====+Compl Dist:====
* Distance from camera that this object will be completely obscured by the fogging effect
* Syntax: ''Number or decimal''

===$AI:===
====+Valid Goals:====
* Valid goals that can be given to this object.
* Syntax: ''( "goal" "goal" )''
* '''Goals:'''
** attack ship
** dock
** waypoints
** waypoints once
** depart
** attack subsys
** form on wing
** undock
** attack wing
** guard ship
** disable ship
** disarm ship
** attack any
** ignore ship
** ignore ship (new)
** guard wing
** evade ship
** stay near ship
** keep safe dist
** rearm ship
** stay still
** play dead
** attack weapon
** fly to ship

====+Accept Player Orders:====
* Whether or not ship type will accept orders from player
* Syntax: ''Yes/No''

====+Player Orders:====
* Orders that ship type will accept from player
* Syntax: ''( "goal" "goal" )''
* '''Orders:'''
** attack ship
** disable ship
** disarm ship
** disable subsys
** guard ship
** ignore ship
** form on wing
** cover me
** attack any
** depart
** dock
** rearm me
** abort rearm
** stay near me
** stay near ship
** keep safe dist

====+Auto Attacks:====
* Whether or not ship type will auto attack nearby ships
* Syntax: ''Yes/No''

====+Attempt Broadsides:====
* Whether or not ship type will try to use broadside tactics against enemy ships
* Syntax: ''Yes/No''

====+Actively Pursues:====
* Which ship types the current ship type will actively pursue (rather than simply return to guard position or whatnot)
* Syntax: ''( "type" "type" )''

====+Guards Attack this:====
* Whether ships assigned to guard another ship will attempt to engage ships of the type
* Syntax: ''Yes/No''

====+Turrets Attack This:====
* Whether or not turrets will target the ships of the type
* Syntax: ''Yes/No''

====+Can Form Wing:====
* Whether or not ship type can be formed into a wing
* Syntax: ''Yes/No''

====+Active Docks:====
* Preferred docking bay type for ship when it is initiating the dock with another ship
* Syntax: ''( "bay" "bay" )''
* '''Dock bays:'''
** cargo
** rearm
** generic

====+Passive Docks:====
* Preferred docking bay type for ship when it is receiving a dock from another ship
* Syntax: ''( "bay" "bay" )''
* '''Dock bays:'''
** cargo
** rearm
** generic

==#End==

==Examples==
Examples are taken directly from code
===Ship Type: "Fighter"===
<pre>
$Name: Fighter
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"waypoints"
"waypoints once"
"depart"
"attack subsys"
"attack wing"
"guard ship"
"disable ship"
"disarm ship"
"attack any"
"ignore ship"
"ignore ship (new)"
"guard wing"
"evade ship"
"stay still"
"play dead"
"stay near ship"
"keep safe dist" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"disable ship"
"disarm ship"
"guard ship"
"ignore ship"
"ignore ship (new)"
"form on wing"
"cover me"
"attack any"
"depart"
"disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )</pre>
===Ship Type: "Freighter"===
<pre>
$Name: Freighter
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Scannable: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 1.75
$Beams Easily Hit: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship"
"attack ship"
"attack wing"
"dock"
"waypoints"
"waypoints once"
"depart"
"undock"
"stay still"
"play dead"
"stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship"
"dock"
"depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport"
"freighter"
"awacs"
"gas miner"
"cruiser"
"corvette"
"capital"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Active docks: ( "cargo" )
+Passive docks: ( "support" )</pre>

[[Category: Tables]]

Objecttypes.tbl

2006-04-22T08:57:15Z

WMCoolmon: Added general information on use as a modular table

Objecttypes.tbl

2006-04-22T08:54:20Z

WMCoolmon:

Objecttypes.tbl

2006-04-22T08:51:48Z

WMCoolmon: Finish of original addtion

Objecttypes.tbl

2006-04-22T08:42:16Z

WMCoolmon: Initial addition of page

Command-Line Reference

2006-01-18T20:16:39Z

WMCoolmon: /* -fov */

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular lighting. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-nobeampierce====
Causes beams to hit (and damage) shields before they impact a ship's hull. This is a global flag, but this behavior can also be modified in weapons.tbl.
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.
===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
'''''What does this do?'''''
====-restricted====
'''''What does this do?'''''
====-multilog====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
'''''What does this do?'''''
====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-env====
Enables environment mapping. Direct3D only. Environment mapping intensity will be determined from the intensity of specular maps.
====-alpha_env====
Enables alpha environment mapping. Direct3D only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
Converts all TGA images to 16-bits. Reduces memory footprint at the expense of image quality.

----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows statistics.
====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows memory usage.
====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====
Reduces the ambient lighting levels.

Takes one argument decimal. The range is specified as a percent, so 0 is no ambient lighting, 100 is default levels.
====-spec_exp====
'''''What does this do?'''''

Takes one argument decimal.
====-spec_point====
'''''What does this do?'''''

Takes one argument decimal.
====-spec_static====
'''''What does this do?'''''

Takes one argument decimal.
====-spec_tube====
'''''What does this do?'''''

Takes one argument decimal.
====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====
Specifies a higher priority game directory.

Takes one argument string, the name of the directory in which the target mod is contained. Explicit use of this command line should be unnecessary as the launcher has MOD options, though multiple mods are supported and do require manual entry.

Data precidence with -mod is as follows (mod directory "moddir")
#moddir/data/(appropriate directory)/
#moddir/data/
#moddir/
#Freespace2/data/(appropriate directory)
#Freespace2/data/
#Freespace2/
====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by a stand-alone server.

Takes one argument string, the name to be assigned to the game being created.
====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Development Reference

2006-01-14T20:30:10Z

WMCoolmon:

[[Scripting API]]
[[FS2_Open Lua Scripting]]

Coding In C

2006-01-11T21:01:55Z

WMCoolmon:

==File types==
There are two main types of file types in C/C++; .c/.cpp files, and .h files. .c/.cpp files are the meat of the source code; they contain the actual function and variable definitions. When a program is '''''built''''', it is '''''compiled''''' to create machine-readable code. To form a complete program, the machine code is '''''linked''''' with other compiled .c/.cpp files to form the complete program (the .exe).

.h files contain code, such as class, function, or struct definitions, that is used in multiple files but usually doesn't really do anything when the program is built.

==Comments==
Anything after // is considered a comment and ignored. Also, anything between a /* and a */ is considered as well (This is called a '''''block comment'''''). You may not put block comments inside of each other, although you can put pretty much anything else in them.

Note that comments are not ignored if they are inside '''''strings''''' (read on to find out what strings are!).

===Comments Example===
<pre>
//I'm a comment!
/* So am I.*/
/* Look, you can do //this and //this! */
char String[] = "//I look like a comment but I'm really a string.";
</pre>

==Variables==
C and C++ have a number of different types of variables; these are slices of memory that hold information. Because all variables are stored in binary, they are interchangeable, to a degree. '''All variables are case sensitive'''

For example, an '''''int''''' is an integer, or a number without any fractions or decimals; -2,-1,0,1,2,3,4,5...etc. An integer is 4 bytes, or 32-bits, long.

Another important type of variable is '''''char'''''. A char is one byte (8 bits) in size. It's essentially a shorter int, except it's most commonly used to represent a character, that is, letters and numbers and such. This means that any given letter is also a number; 'A' is 65, for example. This text->number conversion is called [http://www.cplusplus.com/doc/papers/ascii.html ASCII]. Single quotation marks are used to denote a character. For example, 'A'

A collection of characters is called a '''''string'''''; this isn't really a variable, however, it is standard. A string is a series of characters followed by a null character, or a char with a value of 0. (NOT the character '0'; that would be 48). Double quotation marks are used to denote a string. So, "This is a string". 'This is not a string'.

If you want to use decimals or fractions you'll have to use a '''''float''''' or a '''''double'''''. A float is the same size as an int, except it can be fractions. A '''''double''''' is twice as large as an int (8 bytes) but can be much more accurate than a float.

Finally, all the above integers can be prefixed with '''''unsigned'''''; this means that the variable only contains positive values. The '''''extern''''' prefix indicates that the variable exists, but is in some other file, so the compiler should let it be used. (The linker will complain if it doesn't really exist). '''''const''''' means that the variable can't be changed by the program after it's built, which lets addtional optimizations be performed. Some other prefixes are '''''short''''' and '''''long''''' - look them up if you're interested.

===Variable example===
<pre>
int i; //Create the variable i.
i = 42; //Set i equal to 42
int j = 94; //Create the variable j and set it to 94
j = -1 * (i * j + 1138); //You can also use arithmetic signs - Now j is -5086!
</pre>

==Arrays==
An array is a series of the same type of variable. So, a string would be an array of chars. An individual variable in an array is usually called an '''''element'''''

===Array example===
<pre>
int Array[2]; //Create an integer array with two integers
Array~[0] = 42; //Set the first integer to 42
Array~[1] = 94; //Set the second integer to 94
char String[] = "Hello!"; //Create an array of chars (a string) and autosize it to whatever size the given string is
</pre>

==Pointers==
Pointers are difficult to grasp and work with, to say the least, but they're worth it. A pointer is basically the address of a particular variable (sometimes a function). Think of them as the address to a house, or the URL to a site - they aren't the actual house or site, but they let you get to it.

There are two important characters with pointers - '''''&''''' and '''''*'''''. & is used to change a variable to the address of a variable. So, &variable would give you the address of a variable.

The asterisk is the reverse of &. It means the variable at the address given. In other words, *(&variable) is the same thing as variable.

However, the asterisk can also be used to declare a pointer, a special type of variable. Confused yet? Here's an example:

===Pointer example===
<pre>
int i = 42; //Our favorite integer, i
int *integerptr; //This defines a pointer to an integer.
integerptr = &i; //integerptr now points to i
(*integerptr) = 94; //We just changed the value of i!
</pre>

==Functions==
A function is a collection of instructions (usually other functions). Every function has a return type - even if it doesn't. A function with no return type has a return type of '''''void'''''. Otherwise, a function may return with any of the above variable types (A function can't really return a string or array, although it can return a '''''pointer''''' to one).

Functions can also be given arguments, so one function can be used in different places. These arguments can be the same types as a function's return types. This means you can take the return of one function and plug it into another function's arguments.

There are two steps to creating a function. Actually writing the function, and optionally declaring it. Thus, you can declare a function in a header file and use that function through your entire project, but only have the meat of it in one spot. You must declare or write out the function before you use it.

Note that the arguments to a function are not really the variables that are plugged into them. So, if you want to change a variable from inside a function , you will probably have to use a pointer. This is called '''''passing by reference'''''

===Function example===
<pre>
void func1(int a, float b); //Declare func1
int func2() //Define func2
{
return 1; //func2 returns integer 1;
}
int func3(int c) //Define func3
{
func1(c, c + .5); //execute func1
return c; //return c;
}

void func1(int a, float b) //Define func1. It doesn't do anything, basically.
{
float z = a + b; //Make a new variable and add up a and b in it
}

void Execute() //You can't execute a function except from inside another.
{
func1(func2(), func3(func2())); //What will z be?
}
</pre>
==Tutorial One - Baby Steps==
To start out, I'll give a classic example - a "Hello, World!" program written in C. Are you ready? Here it is...
<pre>
#include <stdio.h>

int main(int argc, char** argv)
{
puts("Hello, world!");
return 0;
}
</pre>
----
That wasn't too bad, was it? Here's what each line does:

<pre>!#include <stdio.h></pre>

This line puts the contents of the file "stdio.h" into the current source code file after it's loaded into memory but before it's compiled. The '<' and '>' tell the compiler that it's a library file - that is, it's not part of the current program but in the compiler's own file list. We need this file to get the function declaration for puts().

The entire line is called a '''''preprocessor directive'''''; that's what the '#' is for. The preprocessor does everything before the code is compiled, adding or replacing source code before it's sent off to the compiler. It's useful if you want to make it easy to completely remove a feature from a program.

<pre>int main(int argc, char** argv)</pre>
This defines the main function, which is where execution in a C program always starts. Argc is the number of command-line arguments, argv is the array of command-line arguments. (ie argv[0] might be "-fps")

<pre>{</pre>
Starts the main function's code block

<pre>puts("Hello, world!");</pre>
This function writes "Hello, world!" to the command-line, or console if you're on Linux.

<pre>return 0;</pre>
This can return pretty much anything you like, as long as it's an integer.

<pre>}</pre>
Ends the function block

That's it! A working C program!

==Scope==
The '''''scope''''' of a variable is the area you can get at it. A variable created inside a function only exists inside that function. Basically, anywhere you see brackets like { or } defines a code block. Any time you see these, variables created inside them will only exist inside of them.

===Scope Example===
<pre>
int a = 1;
void func1()
{
//You can access a here, but not c or d
int b;
}

void func2()
{
//You can access a here, but not b or d
if(a)
{
int d = 2;
}
}
</pre>
==Flow control - If statement==
If the code in the parentheses is true, or a nonzero value, then the code statement immediately after it or inside the code block immediately after it is executed. After if, '''''else if''''' may be used to define an alternate option. Or, '''''else''''' may be used to define if none of the else or else if blocks are true

===If example===
<pre>
int a = 1;
int b = 2;
if(a == 0)
{
//Do something fun if a is 0
}
else if(a == 1)
{
//Do something else if a is 1
}
else if(a == 1 && b == 2)
{
//If a is 1, and b is 2, do something here.
//With the above values, this is what would happen.
}
else
{
//Otherwise, do this.
}
</pre>

==Flow control - while statement.==
While the code in the parentheses is true or a nozero value, then the code statement immediately after it or inside the code block immediately after it is executed.

===While example===
<pre>
int i; //Create the variable i
void DoStuff();//Declare teh function DoStuff

i = 0; //Make i be 0
while(i < 42) //While this is true, do whatever's after this
{
DoStuff();
i++; //++ is shorthand for "Add 1 to the variable after this line of code".
//++i; //This would be shorthand for "Add 1 to the variable before this line of code"
//Replace with -- for "Subtract one from"
}
</pre>

==Flow control - for statement==
Usually used to go through array values; essentially a variant of the while loop

===For example===
<pre>
//This does the same thing as the while example
int i;
void DoStuff();

for(i = 0; i < 42; i++)
{
DoStuff();
}
</pre>

==Flow control - switch==
Execute the code after the case statement that matches the value in the parentheses.

===Switch example===
<pre>
//Declare some functions
void DoFunStuff();
void DoSadStuff();
void DoOtherStuff();

//Give ourselves a variable
int a = 2;

switch(a)
{
case 0: //If a is 0...
DoFunStuff(); //...Do fun stuff!
break; //We're done, jump to the end of the code block.
case 1: //If a is 1...
DoSadStuff(); //...aww, crap, we gotta do sad stuff.
break;
default: //If none of the above match...
DoOtherStuff(); //...Do some other stuff.
//Since a IS 2, we'll be doing this other stuff.
break;
}
</pre>

==Structs==
Structs are a block of different types of variables. They help organize code, since then you can group similar variables together. For example:

===Struct Example===
<pre>
struct Person
{
char name[128]; //Name can *only* be 128 letters long, including spaces
unsigned int age; //Granted, ints range from -2,147,483,648 to 2,147,483,648 - but just in case...
unsigned int weight;//Who has negative weight?

}; //<-- this little semicolon is important. Remember him.

//Now we have a function that takes a Person as an argument.
int CarlEatClone(Person poor_fellow)
{
for(;poor_Fellow.weight > 0; poor_fellow.weight--); //Simulate this poor fellow being digested.

//Note that no one is actually harmed, because the poor_fellow is actually a copy.
//Also note how "weight" inside poor_fellow is referenced
}
//Use like this:
//CarlEatClone(TerranGuy);

//In this function, poor_fellow must be a pointer
int CarlEat(Person *poor_fellow)
{
for(;poor_fellow->weight > 0; poor_fellow->weight--);

//Note again how weight is referenced, now that poor_fellow is a pointer
//No cloning is involved here...poor guy.
}
//Use like this:
//CarlEat(&TerranGuy);
</pre>
----
Written by [[User:WMCoolmon|WMCoolmon]]

Source Code Project index

2006-01-11T20:34:42Z

WMCoolmon: /* Getting Started with the Source Code Project */

===Getting Started with the Source Code Project===

[[FSSCP Introduction]]
 [[Installing fs2_open]]
 [[FS2 data installation]]
 [[Installing mods for fs2_open]]
 [[Troubleshooting]]
 [[Bug Reporting]]

===Getting Started with Development===
 [[Coding In C]]

[[Category:Source Code Project]]

Shivan Manifesto

2006-01-08T16:25:38Z

WMCoolmon: Re-added non-canon notice

{{non-canon}}
The Shivan Manifesto is a long, complex document, which describes (in detail) a theory on the origins and motivations of the Shivans during the events of the Freespace saga. Though the theory has gained some support, it has many detractors, and is not considered canon, nor is it generally accepted by the FS community.

== Summary of the Manifesto ==

The theory outlined in the Manifesto is based on the idea that the subspace travel performed by Terrans and Vasudans is harmful to subspace. It claims that the Shivans are energy beings from subspace, that use a kind of exoskeleton to maintain integrity in our own plane of existence, and their attacks against the two races are the Shivans aggressive defence of their home dimension whenever large levels of subspace activity occur in any given area of space.

The theory also explains the Shivans' motivation for destroying Capella as an act of fear, lest the GTVA deploy more Colossi in large numbers, as they were not able to understand how a civillization's technology could evolve so quickly. It also suggests that this retreat is due to the SOC mission where you are ordered to destroy a number of unknown Shivan devices, which the Manifesto states are responsible for Shivan life-support.

== Support for the Theory ==

The theory itself is based largely on conjecture from both the Ancients and Bosch monologues in Freespace 1, and Freespace 2, respectively, and a number of the ideas (such as the Shivans as energy beings) are not mentioned by any canon sources.

== Criticisms of the Theory ==

According to its detractors, the theory omits or ignores many significants pieces of information from the games, and overemphasizes the significance of others. It also makes several significant statements based almost entirely on guesswork, with no indication from either game to base these statements on.

Specifically, it makes major assumptions about the nature of the ETAK device, the Shivan Comm Nodes and the Shivans themselves without ingame evidence, and contradicts in game evidence on several points (for example, the beleif that the Shivans would be frightened of the possibility of multiple [[GTVA Collossus|Colossus]] class vessels without any evidence that such vessels exist).

A more detailed list of the criticsms of the theory can be found on the [[Criticisms of the Shivan Manifesto]] page.

== Text of the Manifesto ==

The full text of the Manifesto can be found in [http://www.cyd.liu.se/users/~johbu692/The%20Shivan%20Manifesto.pdf PDF Form]

Shivan Manifesto

2006-01-05T01:43:04Z

WMCoolmon:

'''''This article is about an individual fan's or a group of fans' interpretation of canonical information, and should not be considered as part of the official Freespace continuity'''''

== Summary of the Manifesto ==

The Shivan Manifesto was a long and extensive document written (and later revised), on the origins and motivations of the Shivans. Essentially, the theory is based on the idea that the Shivans are energy beings from subspace, that use a kind of exoskeleton to maintain integrity in our own plane of existence. Also central to the theory is that the subspace travel performed by Terrans and Vasudans is harmful to subspace, and as a result, causes the Shivans to aggressively defend their home dimension whenever large levels of subspace activity occur in any given area of space.

The theory also explains the Shivans' motivation for destroying Capella as an act of fear, lest the GTVA deploy more Colossi in large numbers, as they were not able to understand how a civillization's technology could evolve so quickly. It also suggests that this retreat is due to the SOC mission where you are ordered to destroy a number of unknown Shivan devices, which the Manifesto states are responsible for Shivan life-support.

== Support for the Theory ==

The theory itself is based largely on conjecture from both the Ancients and Bosch monologues in Freespace 1, and Freespace 2, respectively, and a number of the ideas (such as the Shivans as energy beings) are not mentioned by any canon sources. As a result, the theory itself is highly controversial among Freespace fans (and is certainly not generally accepted as an official interpretation of events).

== Text of the Manifesto ==

The full text of the Manifesto can be found in [http://www.cyd.liu.se/users/~johbu692/The%20Shivan%20Manifesto.pdf PDF Form]

Shivan Manifesto

2006-01-05T01:23:15Z

WMCoolmon:

'''''This article is about an individual fan's or a group of fans' interpretation of canonical information, and should not be considered as part of the official Freespace continuity'''''

== Summary of the Manifesto ==

The Shivan Manifesto was a long and extensive document written (and later revised), on the origins and motivations of the Shivans. Essentially, the theory is based on the idea that the Shivans are energy beings from subspace, that use a kind of exoskeleton to maintain integrity in our own plane of existence. Also central to the theory is that the subspace travel performed by Terrans and Vasudans is harmful to subspace, and as a result, causes the Shivans to aggressively defend their home dimension whenever large levels of subspace activity occur in any given area of space.

The theory also explains the Shivans' motivation for destroying Capella as an act of fear, lest the GTVA deploy more Colossi in large numbers, as they were not able to understand how a civillization's technology could evolve so quickly. It also suggests that this retreat is due to the SOC mission where you are ordered to destroy a number of unknown Shivan devices, which the Manifesto states are responsible for Shivan life-support.

== Support for the Theory ==

The theory itself is based largely on conjecture from both the Ancients and Bosch monologues in Freespace 1, and Freespace 2, respectively, and a number of the ideas (such as the Shivans as energy beings) are not mentioned by any canon sources. As a result, the theory itself is highly controversial among Freespace fans.

== Text of the Manifesto ==

The full text of the Manifesto can be found in [http://www.cyd.liu.se/users/~johbu692/The%20Shivan%20Manifesto.pdf PDF Form]

Weapons.tbl

2005-12-28T06:09:41Z

WMCoolmon:

Made following the older guide (originally written by GE) by
*Wanderer
*Contribute and include yourself here

==Special Case Weapons==
===Beam Cannons===
*'''REQUIRES: "beam" flag'''
*'''REQUIRES: [[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''
===Flak Guns===
*'''REQUIRE: "flak" and "particle spew" flags'''
*Must have inner and outer radius defined to have any effect.
*Does not use any model or weapon effect though model must be defined, usually Hornet.pof. Instead it uses particle spew. Trails can also be added.

==Weapons Table==
*Retail options will look like this


*SCP options are marked with red color
**Most of the entries in ships.tbl are optional (does anyone have the default values?)


===General Format===
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

===Core Table===

====$Name:====
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. If the weapon has an @ symbol in front of it, it means it's allowed in the demo. It doesn't really do anything in the retail version.
*Syntax: ''Name''


====$Subtype:====


====+Title:====
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything.
*Syntax: XSTR(''"Title"'', -1)

====+Description:====
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons.

XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text

====+Tech Title:====
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR(''"Title"'', -1)

====+Tech Anim:====
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: ''Filename''
**Example: ''Tech_Subach_HL-7''

====+Tech Description:====
*Descriptive text you see in the tech room. Only needed for player allowed weapons.

XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text


====$Tech Model:====
*Defines model used in wing loadout screen and in Tech Room for the weapon. As of the moment - not totally functional
*Syntax: ''Filename.pof''

====$HUD Image:====
*Defines the picture used in HUD loadout list
*Syntax: ???


====$Model File:====
*Filename of the model file (.pof) at data/models folder. Additional fields beginning from '''''@Laser Bitmap:''''' and ending to '''''@Laser Tail Radius:''''' are not needed if a model has been defined for the weapon.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: ''Filename.pof'' or ''none''
**Example: ''none''


====$POF target LOD:====
*Defines the LOD (Level-Of-Detail) of the model used in HUD targetting view
*Syntax: ''Value''

====$External Model File:====
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: ''Filename.pof''

====$Submodel Rotation Speed:====

====$Submodel Rotation Acceleration:====


====@Laser Bitmap:====
**The graphic file to be used as the weapon effect if no model is defined.
**Syntax: ''Filename''

====@Laser Glow:====
**The graphic file that determines the glow of the weapon effect if no model is defined
**Syntax: ''Filename''

====@Laser Color:====
**The color of the weapon effect when you fire it.
**Syntax: ''Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: ''250, 0, 0''

====@Laser Color2:====
**The color of the weapon effect at its maximum range.
**Syntax: ''Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: ''0, 0, 250''

====@Laser Length:====
**Length of the weapon effect.
**Syntax: ''Value'', (1/10 of a meters)

====@Laser Head Radius:====
**Width of the head of the weapon effect.
**Syntax: ''Value'', (meters ?)

====@Laser Tail Radius:====
**Width of the tail of the weapon effect.
**Syntax: ''Value'' (meters ?)

====$Mass:====
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*Syntax: ''Value'', (blast effect)

====$Velocity:====
*How fast the weapon travels. Is also used to define the weapon range, $Velocity x $Lifetime = range.
*Beams travel instantly so this field has effect only on weapon range and AI beam targetting with certain beam types.
*Syntax: ''Value'', (meters per second)

====$Fire Wait:====
*Time in seconds between firings
*Syntax: ''Value'', (seconds)

====$Damage:====
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: ''Value'', (damage value)


====$Damage Type:====
*Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage. REQUIRES ADDITIONAL TABLE.
*Syntax: ''Name'', of the damage type as defined in armor.tbl

====$Arm time:====
*Defines the time after the launch that is required before the weapon comes hot
*If the time has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: ''Value'', (seconds)

====$Arm distance:====
*Defines the distance from the firing ships that is required before the weapon comes hot
*If the distance has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: ''Value'', (meters)

====$Arm radius:====
*Defines the distance from the target where the weapon will arm itself
*Syntax: ''Value'', (meters)

====$Detonation Range:====
*Defines the distance from the point in space that the weapon was launched where the weapon will deatonate
*Syntax: ''Value'', (meters)

====$Shockwave damage:====
*Override for the damage caused by shockwaves
*Syntax: ''Value'', (damage value)

====$Shockwave Damage Type:====
*REQUIRES ADDITIONAL TABLE. Defines the damage type used for the weapon explosions
*Syntax: ''Name'', as defined in armor.tbl


====$Blast Force:====
*The intensity of the blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: ''Value'', (blast effect)

====$Inner Radius:====
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins.
*Syntax: ''Value'', (meters)

====$Outer Radius:====
*Maximum radius at which any damage is done
*Syntax: ''Value'', (meters)

====$Shockwave Speed:====
*Speed shockwave expands at. Zero means no shockwave and that damage is applied immediately
*Syntax: ''Value'', (meters per second)


====$Shockwave rotation:====
*Defines how the shockwave is rotated.
*Syntax:

====$Shockwave model:====
*Defines the model file (.pof) used as a shockwave for 3D shockwaves.
*Implemented before FS_Open 3.6.5
*Syntax: ''Name.pof''

====$Shockwave name:====
*Defines the name of the animation used for the shockwave
*Syntax: ''Name''

====$Dinky shockwave:====
*Dinky shockwave are used if the weapon is shot down or if the conditions marked at Arm time and Arm distance are not reached
*It uses exactly same entries as the standard shockwaves
*'''+Shockwave damage:'''
*'''+Shockwave damage type:'''
*'''+Blast Force:'''
*'''+Inner Radius:'''
*'''+Outer Radius:'''
*'''+Shockwave Speed:'''
*'''+Shockwave Rotation:'''
*'''+Shockwave Model:'''
*'''+Shockwave Name:'''


====$Armor Factor:====
*Multiplier for the damage done to armor
*Syntax: ''Value'', (damage multiplier)

====$Shield Factor:====
*Multiplier for the damage done to shields
*Syntax: ''Value'', (damage multiplier)

====$Subsystem Factor:====
*Multiplier for the damage done to subsystems
*Syntax: ''Value'', (damage multiplier)


====$Lifetime Min:====
*Defines the minimum lifetime of the weapon (countermeasure)
*Syntax: ''Value'', (seconds)

====$Lifetime Max:====
*Defines the maximum lifetime of the weapon (countermeasure)
*Syntax: ''Value'', (seconds)


====$Lifetime:====
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targetting with certain beam types
*Syntax: ''Value'', (seconds)

====$Energy Consumed:====
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: ''Value''

====$Cargo Size:====
*Cargo size, is not used with primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: ''Value''

====$Homing:====
*Only for secondaries. You can't have homing primaries. If this is set to YES with primaries, then the bolts turn to face their target but keep moving in the same direction. If the field is set to NO then following fields are not required in the table.
*Defines if the missiles in question is homing
*Syntax: ''YES'' or ''NO''
*'''+Type:'''
**Defines the homing method
**Syntax: ''ASPECT'' or ''HEAT''
*'''+Turn Time:'''
**Defines how well missile manouvers. Number of seconds it takes the missile to do a 360 degree circle
**Syntax: ''Value'', (seconds)
*'''+View Cone:'''
**'''Heat-seeking missiles only''', this is then number of degrees the missile sees. Value / 2 gives the angle from the missiles centerline. Has been enabled also to aspect seekers. 
**Syntax: ''Value'', (degrees)
*'''+Min Lock Time:'''
**'''For aspect missiles only''', the minimum number of seconds to gain target lock
**Syntax: ''Value'', (seconds)
*'''+Lock Pixels/Sec:'''
**'''For aspect missiles only''', pixels the aspect triangle moves per second while attempting lock-on
**Syntax: ''Value'', (pixels per second)
*'''+Catch-up Pixels/Sec:'''
**'''For aspect missiles only''', pixels moved per second while attempting to catch up to the target
**Syntax: ''Value'', (pixels per second)
*'''+Catch-up Penalty:'''
**'''For aspect missiles only''', extra pixels to move after catching up ????
**Syntax: ''Value'', (pixels)

*'''+Seeker Strenght:'''
**Defines the seeking ability of the homing system. Default of heat seekers is 3 and for aspect seekers 2. Spoofing change is defined as '''cm type effectiveness'''/'''seeker strength'''.
**Syntax: ''Value'', (seeker strenght)


====$Swarm:====
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes singlepart turrets to malfunction but causes multipart turrets to fire only on their barrel line. Can be used for 'burst fire weapons'.
*Is incompatible with "Corkscrew" option.
*Syntax: ''Value''

*'''+SwarmWait:'''
**Implemented before FS_Open 3.6.5
**Defines the time between weapons fired in a swarm
**Syntax: ''Value'', (milliseconds)
***Default: 150

====$Free Flight Time:====
*Defines the free flight time of homing weapons. During this time weapon flies at 1/4 of its velocity + firing ships velocity in a straight line.
*Syntax: ''Value'', (seconds)
**Default: 0.25


====$LaunchSnd:====
*Corresponding sound effect when the weapon is launched.
*Syntax: ''Value'', name or identification number of the sound as defined in sounds.tbl

====$ImpactSnd:====
*Sound the weapon makes when it hits a hull.
*Syntax: ''Value'', name or identification number of the sound as defined in sounds.tbl


====$Disarmed ImpactSnd:====
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl


====$FlyBySnd:====
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: ''Value'', name or identification number of the sound as defined in sounds.tbl, usually -1


====$Model:====
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: ''Filename.pof''


====$Rearm Rate:====
*Defines the rate the weapons are loaded to the ship
*Syntax: ''Value'', (missiles per s)

====+Weapon Range:====
*Defines the range to the target where the weapons under AI will start firing.??
*Syntax: ''Value'', (meters)


====+Weapon Min Range:====
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: ''Value'', (meters)


====$Flags:====
*Flags are detailed below, in [[weapons.tbl#Weapon Flags|weapon flags section]].

====$Trail:====
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: ''Value'', (meters)
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: ''Value'', (meters)
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: ''Value'' value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: ''Value'', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: ''Value'', (seconds)
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: ''Filename''

====$Icon:====
*Loadout icon used in the weapons selection screen.
*Syntax: ''Filename''

====$Anim:====
*Green grid animation used on the weapons screen.
*Syntax: ''Filename''

====$Impact Explosion:====
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: ''Filename'' or ''none''

====$Impact Explosion Radius:====
*Radius of the defined impact explosion.
*Syntax: ''Value''


====$Dinky impact explosion:====
*Same as Impact explosion but for Dinky explosions

====$Dinky impact explosion radius:====
*Same as Impact explosion radius but for Dinky explosions


====$Muzzleflash:====
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: ''Muzzleflash name'', as defined in mflash.tbl

====$EMP Intensity:====
**If it has an EMP effect, how deeply it scrambles your electronics
**Syntax: ''Value''

====$EMP Time:====
**Duration of the EMP effect
**Syntax: ''Value'', (seconds)

====$Leech Weapon:====
**The amount of weapon energy to drain with each hit
**Syntax: ''Value''

====$Leech Afterburner:====
**The amount of afterburner fuel to drain with each hit
**Syntax: ''Value''


====$Corkscrew:====
*Implemented before FS_Open 3.6.5
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: ''Value''
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: ''Value'', (meters)
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: ''Value'', (milliseconds)
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: ''Value'' (radians per second)

====$Electronics:====
*Implemented before FS_Open 3.6.5
*Defines the weapons effect against electronics
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options
*'''+Old Style:'''
**Defines that the electronics use the old style
*'''+Intensity:'''
**May only be used with new style electronics
**Syntax: ''Value''
*'''+Lifetime:'''
**Syntax: ''Value''
*'''+Engine Multiplier:'''
**May only be used with new style electronics
**Syntax: ''Value''
*'''+Weapon Multiplier:'''
**May only be used with new style electronics
**Syntax: ''Value''
*'''+Beam Turret Multiplier:'''
**May only be used with new style electronics
**Syntax: ''Value''
*'''+Sensors Multiplier:'''
**May only be used with new style electronics
**Syntax: ''Value''
*'''+Randomness Time:'''
**Syntax: ''Value''

====$Spawn Angle:====
*Implemented before FS_Open 3.6.5
*Defines the cone (with an angle) where the spawned weapons appear. Value / 2 gives the angle from the missiles centerline.
*Syntax: ''Value'', (degrees)

====$Local SSM:====
*Implemented before FS_Open 3.6.5
*Defines the local SSM.
*'''+Warpout Delay:'''
*'''+Warpin Delay:'''
*'''+Stage 5 Velocity:'''
*'''+Warpin Radius:'''
*'''+Lock Range:'''

====$Countermeasure:====
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: ''Value'', (cm type effectiveness)
***Default: 1
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: ''Value'', (cm type effectiveness)
***Default: 1
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: ''Value'', (meters)
***Default: 300


====$BeamInfo:====
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal. Nobody knows what Type 2 beams are.
**Syntax: ''Value'', only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: ''Value'', (seconds)
*'''+Warmup:'''
**Warmup time
**Syntax: ''Value'', (milliseconds)
*'''+Warmdown:'''
**Warmdown time
**Syntax: ''Value'', (milliseconds)
*'''+Radius:'''
**Muzzle glow radius
**Syntax: ''Value'' (meters)
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: ''Value''
*'''+PRadius:'''
**Particle radius
**Syntax: ''Value'', (meters)
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: ''Value'', (angle of the cone)
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: ''Filename''
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: ''Value Value Value Value Value'', Very Easy, Easy, Moderate, Hard, Very Hard respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+Muzzleglow:'''
**Defines the bitmap used t create the muzzle glow
**Syntax: ''Filename''
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: ''Value''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: ''Value''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: ''Value''

*'''+Range:'''
**Implemented before FS_Open 3.6.5
**Defines the maximum range where the beam still has any effect.
**Syntax: ''Value'', (meters)
*'''+Attenuation:'''
**Implemented before FS_Open 3.6.5
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: ''Value'', (from 0 - firing point to 1 - no effect)
***Default: 1

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
**'''+Width:'''
***Width of the section
***Syntax: ''Value'' (meters)
**'''+Texture:'''
***Texture for the section
***Syntax: ''Filename''
**'''+RGBA Inner:'''
***Defines the color and transparency of the center of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 255 255 255 255
**'''+RGBA Outer:'''
***Defines the color and transparency of the edges of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 150 150 150 10
**'''+Flicker:'''
***Defines how much the section flickers
***Syntax: ''Value'', value from 0 to 1
**'''+Zadd:'''
***Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
***Syntax: ''Value'' 
**'''+Tile Factor:'''
***Implemented before FS_Open 3.6.5
***Defines the beam texture tileing factor.
***Syntax: ''Value'', (from 0 to 1)
**'''+Translation:'''
***Implemented before FS_Open 3.6.5
***Defines the beam texture moveing stuff.
***Syntax: ''Value'', (from 0 to 1)

====$Pspew:====
*Implemented before FS_Open 3.6.5
*Defines a particle spew effect for the given weapon
*'''+Count:'''
**Defines???
**Syntax: ''Value''
*'''+Time:'''
**Defines???
**Syntax: ''Value'', (seconds)
*'''+Vel:'''
**Defines the created paricles speed relative to the weapon speed
**Syntax: ''Value'', (meters per second)
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: ''Value'', (meters)
*'''+Life:'''
**Defines???
**Syntax: ''Value'', (seconds)
*'''+Scale:'''
**Defines???
**Syntax: ''Value''
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: ''Filename''


====$Tag:====
*Allowed for secondary weapons
*Location: After $Impact Explosion Radius:
*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*Syntax: ''TAG level'' ''Value'', (seconds)


====$SSM:====
*Implemented before FS_Open 3.6.5
*Defines the weapons SSM index number:
*Syntax: ''Value''

====$FOF:====
*Implemented before FS_Open 3.6.5
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: ''Value'', (degrees)

====$Shots:====
*Implemented before FS_Open 3.6.5
*Defines the number of shots every time the weapon is fired.
*Syntax: ''Value'', (number of shots)

====$decal:====
*Implemented before FS_Open 3.6.5
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: ''Filename''
*'''+backface texture:'''
**Defines ???
**Syntax: ''Filename''
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: ''Value'', (meters)
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: ''Value''


==Weapon Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship of cruiser class or below for a short period of time

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Puncture"===
*Reduces hull damage by 25%

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon targetable with the B key, and the AI prefers to use it against large ships

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon

==="Particle Spew"===
*Makes the weapon projectile spew out particles

*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]


==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.

*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]


==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
*Gives this weapon a streaming effect. In effect weapon keeps firing when firing button is kept pressed.

==="puncture"===
*Reduces hull damage by 25%

==="supercap"===
*Makes weapon capable of causing real damage against ships with "supercap" flag.



==="countermeasure"===
*Defines the weapon as a countermeasure

==="Ballistic"===
*Implemented before FS_Open 3.6.5
*Defines the weapon as a ballistic weapon that needs ammunition.

==="pierce shields"===
*Implemented before FS_Open 3.6.5
*Causes weapons to penetrate shield without causing damage to it.

==="no pierce shields"===
*Implemented before FS_Open 3.6.5
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.

==="local ssm"===
*Implemented before FS_Open 3.6.5

==="tagged only"===
*Implemented before FS_Open 3.6.5
*Weapon can only be fired at tagged targets

==="beam no whack"===
*Implemented before FS_Open 3.6.5
*Disables beam whacking. Practically same as setting beam mass to zero.

==="cycle"===
*Implemented before FS_Open 3.6.5
*Causes weapon to alternate between firingpoints

==="small only"===
*Implemented before FS_Open 3.6.5
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)

==="same turret cooldown"===
*Forces the turrets to fire on the designated rate of fire on all difficulty levels


==Countermeasures==
*Usually not altered. Only one can exist

===$Name:===
*Name of the countermeasure
*Syntax: ''Name'', usually Type One

===$Velocity:===
*Defines the spped of the countermeasure, relative to the ship.
*Syntax: ''Value'', (meter per second)

===$Fire Wait:===
*Definies the minumum time between the countermeasure launches
*Syntax: ''Value'', (seconds)

===Lifetime===
*Countermeasure's life time is defined between with minimum and maximum lifetime
*'''$Lifetime Min:'''
**Syntax: ''Value'', (seconds)
*'''$Lifetime Max:'''
**Syntax: ''Value'', (seconds)

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: ''Value'', refers to sounds.tbl

===$Model:===
*Defines the used model file (.pof)
*Syntax: ''Filename.pof'', usually cmeasure01.pof

==Player Weapon Precedence==
*First the primary weapons are defined, from most powerful to least powerful, and then the same for secondaries
*Syntax: ( ''"Name" "Name"'')
*Example:

$Player Weapon Precedence: (
"UD-8 Kayser"
"Prometheus R"
"Subach HL-7"
"Harpoon"
"Tempest"
"Rockeye" )

==Sample==

#Primary Weapons
$Name: @Subach HL-7
+Title: XSTR("GTW Subach HL-7", 3243)
+Description:
XSTR( "Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text
+Tech Title: XSTR("Subach HL-7", 146)
+Tech Anim: Tech_Subach_HL-7
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: none
@Laser Bitmap: newglo9
@Laser Glow: 2_laserglow03
@Laser Color: 250, 0, 0
@Laser Color2: 0, 0, 250
@Laser Length: 10.0
@Laser Head Radius: 0.90
@Laser Tail Radius: 0.90
$Mass: 0.2
$Velocity: 450.0
$Fire Wait: 0.2
$Damage: 15
$Armor Factor: 0.9
$Shield Factor: 0.7
$Subsystem Factor: 0.3
$Lifetime: 2.0
$Energy Consumed: 0.20
$Cargo Size: 0.0
$Homing: NO
$LaunchSnd: 76
$ImpactSnd: 85
$Flags: ( "in tech database"
"player allowed"
"stream")
$Icon: iconSD4
$Anim: SD4
$Impact Explosion: none
#End
#Secondary Weapons
$Name: EMP Adv.
+Title: XSTR("GTM-14 EMP Adv.", 3396)
+Description:
XSTR( "Advanced Missile
Electromagnetic Pulse Weapon
General Purpose Suppression", 3397)
$end_multi_text
+Tech Title: XSTR("GTM-14 EM Pulse Adv.", 3398)
+Tech Anim: Tech_EMP
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: EMPulse2.pof
$Mass: 15.0
$Velocity: 275.0
$Fire Wait: 2.0
$Damage: 45
$Blast Force: 20.0
$Inner Radius: 80.0
$Outer Radius: 300.0
$Shockwave Speed: 120.0
$Armor Factor: 1.0
$Shield Factor: 0.8
$Subsystem Factor: 0.5
$Lifetime: 5.0
$Energy Consumed: 0.0
$Cargo Size: 4.0
$Homing: YES
+Type: ASPECT
+Turn Time: 1.0
+Min Lock Time: 2.0
+Lock Pixels/Sec: 70
+Catch-up Pixels/Sec: 100
+Catch-up Penalty: 30
$LaunchSnd: 118
$ImpactSnd: 88
$FlyBySnd: -1
$Rearm Rate: 2.0
$Flags: ( "player allowed"
"EMP")
$Trail:
+Start Width: 0.25
+End Width: 0.75
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.5
+Bitmap: MissileTrail04
$Icon: iconEMPulse
$Anim: ecm
$Impact Explosion: ExpMissileHit1
$Impact Explosion Radius: 10.0
$EMP Intensity: 375.0
$EMP Time: 20.0
#End
$Player Weapon Precedence: (
"Subach HL-7"
"EMP Adv." )

[[Category:Tables]]

Feature Requests

2005-12-27T01:25:21Z

WMCoolmon:

Feature Requests

2005-12-27T01:15:48Z

WMCoolmon:

This page is primarily to serve as a database for feature requests for the Source Code Project.

== New Requests ==

=== Side Multipart Turrets ===
Support for fully rotating turrets on the sides of ships.
* '''Supported By:''' Battlestar Galactica, The Babylon Project, Wing Commander Saga, Nukemod - Children of Shiva

=== Gatling Turrets ===
Support for Gatling gun turrets, which work same as a regular multipart turret but has an extra subobject (child of the barel) that rotates while the turret is firing.
* '''Supported By:''' Nukemod - Children of Shiva

=== Submodel Animation Triggers & Upgrades ===

Trigger Requests:
* Subspace - Performs animation on entrance to supspace, and undoes when a ship comes out of subspace, and acts as a initial position if the "mission takes place in subspace" flag is set.
*Afterburners - Performs animation when afterburners are used and undoes the anumation when they go off.
*Weapon Fire - Performs animation when weapon is fired and undoes it before the weapon can fire again.
*Sexp - Animation triggered by sexp.
*Flight Control - Triggered by the the activation, toggle or motion of a particular flight control.
*Turret Fire - Performs animation when a particular turret is fired and undoes it before the turret can fire again.
Requested Upgrades:
*Support for "model-relative" movement in addition to "current submodel position-relitive" movement that already exists.
*Incremental movement - moves a submodel to the position indicated, but does not undo the motion.
*Glowpoint linking - Make it possible to activate/deactivate/toggel a certain bank/slot of glowpoint(s).
*Counter-rotate option - allow an object to inherit its parent's motion while counter-rotating, usefull for translation effect.
*Increase heirarchy depth instance limit to at least 10 levels of heirarchy.
*Simple linked animation support - Support for animations liked with flight controls and other variable setting ship controls, usefull for making animated cockpit controls, control surfaces, and thrust vectoring nozzels.
* '''Supported By:''' Nukemod - Children of Shiva, Twisted Infinities, Shadows of Lylat

== In Progress ==
=== Customizable ship types ===
Add a new table (or an addendum to ships.tbl) that would allow modders to turn on and off individual aspects of ship types, as well as define new ones. Type should be settable in the $Flags: variable, just as it is now, and the :V: defaults should be integrated so that they may be overriden by mods.
* '''Supported By:''' The Babylon Project

== Implemented ==
=== Flak Screen ===
Ability to set detonation range/time for flak shots so that flak weapons could fire at approaching ships beyond their 'detonation range' thus generating a flak screen in front of the approaching ships with the flak explosions. Preferably with little variance in the exact detonation time as there is always a little variance in normal flak explosions. Beams already support this sort of firing with +range: option. 
[[User:Wanderer|Wanderer]] 10:56, 9 Dec 2005 (GMT)
* '''Supported By:''' ???

Weapons.tbl

2005-12-27T01:13:24Z

WMCoolmon: Added $Detonation range, fixed $Arm radius description

Made following the older guide (originally written by GE) by
*Wanderer
*Contribute and include yourself here

==Special Case Weapons==
===Beam Cannons===
*'''REQUIRES: "beam" flag'''
*'''REQUIRES: [[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''
===Flak Guns===
*'''REQUIRE: "flak" and "particle spew" flags'''
*Must have inner and outer radius defined to have any effect.
*Does not use any model or weapon effect though model must be defined, usually Hornet.pof. Instead it uses particle spew. Trails can also be added.

==Weapons Table==
*Retail options will look like this


*SCP options are marked with red color
**Most of the entries in ships.tbl are optional (does anyone have the default values?)


===General Format===
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

===Core Table===

====$Name:====
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. If the weapon has an @ symbol in front of it, it means it's allowed in the demo. It doesn't really do anything in the retail version.
*Syntax: ''Name''


====$Subtype:====


====+Title:====
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything.
*Syntax: XSTR(''"Title"'', -1)

====+Description:====
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons.

XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text

====+Tech Title:====
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR(''"Title"'', -1)

====+Tech Anim:====
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: ''Filename''
**Example: ''Tech_Subach_HL-7''

====+Tech Description:====
*Descriptive text you see in the tech room. Only needed for player allowed weapons.

XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text


====$Tech Model:====
*Defines model used in wing loadout screen and in Tech Room for the weapon. As of the moment - not totally functional
*Syntax: ''Filename.pof''

====$HUD Image:====
*Defines the picture used in HUD loadout list
*Syntax: ???


====$Model File:====
*Filename of the model file (.pof) at data/models folder. Additional fields beginning from '''''@Laser Bitmap:''''' and ending to '''''@Laser Tail Radius:''''' are not needed if a model has been defined for the weapon.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: ''Filename.pof'' or ''none''
**Example: ''none''


====$POF target LOD:====
*Defines the LOD (Level-Of-Detail) of the model used in HUD targetting view
*Syntax: ''Value''

====$External Model File:====
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: ''Filename.pof''

====$Submodel Rotation Speed:====

====$Submodel Rotation Acceleration:====


====@Laser Bitmap:====
**The graphic file to be used as the weapon effect if no model is defined.
**Syntax: ''Filename''

====@Laser Glow:====
**The graphic file that determines the glow of the weapon effect if no model is defined
**Syntax: ''Filename''

====@Laser Color:====
**The color of the weapon effect when you fire it.
**Syntax: ''Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: ''250, 0, 0''

====@Laser Color2:====
**The color of the weapon effect at its maximum range.
**Syntax: ''Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: ''0, 0, 250''

====@Laser Length:====
**Length of the weapon effect.
**Syntax: ''Value'', (1/10 of a meters)

====@Laser Head Radius:====
**Width of the head of the weapon effect.
**Syntax: ''Value'', (meters ?)

====@Laser Tail Radius:====
**Width of the tail of the weapon effect.
**Syntax: ''Value'' (meters ?)

====$Mass:====
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*Syntax: ''Value'', (blast effect)

====$Velocity:====
*How fast the weapon travels. Is also used to define the weapon range, $Velocity x $Lifetime = range.
*Beams travel instantly so this field has effect only on weapon range and AI beam targetting with certain beam types.
*Syntax: ''Value'', (meters per second)

====$Fire Wait:====
*Time in seconds between firings
*Syntax: ''Value'', (seconds)

====$Damage:====
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: ''Value'', (damage value)


====$Damage Type:====
*Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage. REQUIRES ADDITIONAL TABLE.
*Syntax: ''Name'', of the damage type as defined in armor.tbl

====$Arm time:====
*Defines the time after the launch that is required before the weapon comes hot
*If the time has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: ''Value'', (seconds)

====$Arm distance:====
*Defines the distance from the firing ships that is required before the weapon comes hot
*If the distance has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: ''Value'', (meters)

====$Arm radius:====
*Defines the distance from the target where the weapon will arm itself
*Syntax: ''Value'', (meters)

====$Detonation Range:====
*Defines the distance from the target where the weapon will detonate
*Syntax: ''Value'', (meters)

====$Shockwave damage:====
*Override for the damage caused by shockwaves
*Syntax: ''Value'', (damage value)

====$Shockwave Damage Type:====
*REQUIRES ADDITIONAL TABLE. Defines the damage type used for the weapon explosions
*Syntax: ''Name'', as defined in armor.tbl


====$Blast Force:====
*The intensity of the blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: ''Value'', (blast effect)

====$Inner Radius:====
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins.
*Syntax: ''Value'', (meters)

====$Outer Radius:====
*Maximum radius at which any damage is done
*Syntax: ''Value'', (meters)

====$Shockwave Speed:====
*Speed shockwave expands at. Zero means no shockwave and that damage is applied immediately
*Syntax: ''Value'', (meters per second)


====$Shockwave rotation:====
*Defines how the shockwave is rotated.
*Syntax:

====$Shockwave model:====
*Defines the model file (.pof) used as a shockwave for 3D shockwaves.
*Implemented before FS_Open 3.6.5
*Syntax: ''Name.pof''

====$Shockwave name:====
*Defines the name of the animation used for the shockwave
*Syntax: ''Name''

====$Dinky shockwave:====
*Dinky shockwave are used if the weapon is shot down or if the conditions marked at Arm time and Arm distance are not reached
*It uses exactly same entries as the standard shockwaves
*'''+Shockwave damage:'''
*'''+Shockwave damage type:'''
*'''+Blast Force:'''
*'''+Inner Radius:'''
*'''+Outer Radius:'''
*'''+Shockwave Speed:'''
*'''+Shockwave Rotation:'''
*'''+Shockwave Model:'''
*'''+Shockwave Name:'''


====$Armor Factor:====
*Multiplier for the damage done to armor
*Syntax: ''Value'', (damage multiplier)

====$Shield Factor:====
*Multiplier for the damage done to shields
*Syntax: ''Value'', (damage multiplier)

====$Subsystem Factor:====
*Multiplier for the damage done to subsystems
*Syntax: ''Value'', (damage multiplier)


====$Lifetime Min:====
*Defines the minimum lifetime of the weapon (countermeasure)
*Syntax: ''Value'', (seconds)

====$Lifetime Max:====
*Defines the maximum lifetime of the weapon (countermeasure)
*Syntax: ''Value'', (seconds)


====$Lifetime:====
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targetting with certain beam types
*Syntax: ''Value'', (seconds)

====$Energy Consumed:====
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: ''Value''

====$Cargo Size:====
*Cargo size, is not used with primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: ''Value''

====$Homing:====
*Only for secondaries. You can't have homing primaries. If this is set to YES with primaries, then the bolts turn to face their target but keep moving in the same direction. If the field is set to NO then following fields are not required in the table.
*Defines if the missiles in question is homing
*Syntax: ''YES'' or ''NO''
*'''+Type:'''
**Defines the homing method
**Syntax: ''ASPECT'' or ''HEAT''
*'''+Turn Time:'''
**Defines how well missile manouvers. Number of seconds it takes the missile to do a 360 degree circle
**Syntax: ''Value'', (seconds)
*'''+View Cone:'''
**'''Heat-seeking missiles only''', this is then number of degrees the missile sees. Value / 2 gives the angle from the missiles centerline. Has been enabled also to aspect seekers. 
**Syntax: ''Value'', (degrees)
*'''+Min Lock Time:'''
**'''For aspect missiles only''', the minimum number of seconds to gain target lock
**Syntax: ''Value'', (seconds)
*'''+Lock Pixels/Sec:'''
**'''For aspect missiles only''', pixels the aspect triangle moves per second while attempting lock-on
**Syntax: ''Value'', (pixels per second)
*'''+Catch-up Pixels/Sec:'''
**'''For aspect missiles only''', pixels moved per second while attempting to catch up to the target
**Syntax: ''Value'', (pixels per second)
*'''+Catch-up Penalty:'''
**'''For aspect missiles only''', extra pixels to move after catching up ????
**Syntax: ''Value'', (pixels)

*'''+Seeker Strenght:'''
**Defines the seeking ability of the homing system. Default of heat seekers is 3 and for aspect seekers 2. Spoofing change is defined as '''cm type effectiveness'''/'''seeker strength'''.
**Syntax: ''Value'', (seeker strenght)


====$Swarm:====
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes singlepart turrets to malfunction but causes multipart turrets to fire only on their barrel line. Can be used for 'burst fire weapons'.
*Is incompatible with "Corkscrew" option.
*Syntax: ''Value''

*'''+SwarmWait:'''
**Implemented before FS_Open 3.6.5
**Defines the time between weapons fired in a swarm
**Syntax: ''Value'', (milliseconds)
***Default: 150

====$Free Flight Time:====
*Defines the free flight time of homing weapons. During this time weapon flies at 1/4 of its velocity + firing ships velocity in a straight line.
*Syntax: ''Value'', (seconds)
**Default: 0.25


====$LaunchSnd:====
*Corresponding sound effect when the weapon is launched.
*Syntax: ''Value'', name or identification number of the sound as defined in sounds.tbl

====$ImpactSnd:====
*Sound the weapon makes when it hits a hull.
*Syntax: ''Value'', name or identification number of the sound as defined in sounds.tbl


====$Disarmed ImpactSnd:====
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl


====$FlyBySnd:====
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: ''Value'', name or identification number of the sound as defined in sounds.tbl, usually -1


====$Model:====
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: ''Filename.pof''


====$Rearm Rate:====
*Defines the rate the weapons are loaded to the ship
*Syntax: ''Value'', (missiles per s)

====+Weapon Range:====
*Defines the range to the target where the weapons under AI will start firing.??
*Syntax: ''Value'', (meters)


====+Weapon Min Range:====
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: ''Value'', (meters)


====$Flags:====
*Flags are detailed below, in [[weapons.tbl#Weapon Flags|weapon flags section]].

====$Trail:====
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: ''Value'', (meters)
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: ''Value'', (meters)
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: ''Value'' value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: ''Value'', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: ''Value'', (seconds)
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: ''Filename''

====$Icon:====
*Loadout icon used in the weapons selection screen.
*Syntax: ''Filename''

====$Anim:====
*Green grid animation used on the weapons screen.
*Syntax: ''Filename''

====$Impact Explosion:====
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: ''Filename'' or ''none''

====$Impact Explosion Radius:====
*Radius of the defined impact explosion.
*Syntax: ''Value''


====$Dinky impact explosion:====
*Same as Impact explosion but for Dinky explosions

====$Dinky impact explosion radius:====
*Same as Impact explosion radius but for Dinky explosions


====$Muzzleflash:====
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: ''Muzzleflash name'', as defined in mflash.tbl

====$EMP Intensity:====
**If it has an EMP effect, how deeply it scrambles your electronics
**Syntax: ''Value''

====$EMP Time:====
**Duration of the EMP effect
**Syntax: ''Value'', (seconds)

====$Leech Weapon:====
**The amount of weapon energy to drain with each hit
**Syntax: ''Value''

====$Leech Afterburner:====
**The amount of afterburner fuel to drain with each hit
**Syntax: ''Value''


====$Corkscrew:====
*Implemented before FS_Open 3.6.5
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: ''Value''
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: ''Value'', (meters)
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: ''Value'', (milliseconds)
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: ''Value'' (radians per second)

====$Electronics:====
*Implemented before FS_Open 3.6.5
*Defines the weapons effect against electronics
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options
*'''+Old Style:'''
**Defines that the electronics use the old style
*'''+Intensity:'''
**May only be used with new style electronics
**Syntax: ''Value''
*'''+Lifetime:'''
**Syntax: ''Value''
*'''+Engine Multiplier:'''
**May only be used with new style electronics
**Syntax: ''Value''
*'''+Weapon Multiplier:'''
**May only be used with new style electronics
**Syntax: ''Value''
*'''+Beam Turret Multiplier:'''
**May only be used with new style electronics
**Syntax: ''Value''
*'''+Sensors Multiplier:'''
**May only be used with new style electronics
**Syntax: ''Value''
*'''+Randomness Time:'''
**Syntax: ''Value''

====$Spawn Angle:====
*Implemented before FS_Open 3.6.5
*Defines the cone (with an angle) where the spawned weapons appear. Value / 2 gives the angle from the missiles centerline.
*Syntax: ''Value'', (degrees)

====$Local SSM:====
*Implemented before FS_Open 3.6.5
*Defines the local SSM.
*'''+Warpout Delay:'''
*'''+Warpin Delay:'''
*'''+Stage 5 Velocity:'''
*'''+Warpin Radius:'''
*'''+Lock Range:'''

====$Countermeasure:====
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: ''Value'', (cm type effectiveness)
***Default: 1
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: ''Value'', (cm type effectiveness)
***Default: 1
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: ''Value'', (meters)
***Default: 300


====$BeamInfo:====
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal. Nobody knows what Type 2 beams are.
**Syntax: ''Value'', only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: ''Value'', (seconds)
*'''+Warmup:'''
**Warmup time
**Syntax: ''Value'', (milliseconds)
*'''+Warmdown:'''
**Warmdown time
**Syntax: ''Value'', (milliseconds)
*'''+Radius:'''
**Muzzle glow radius
**Syntax: ''Value'' (meters)
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: ''Value''
*'''+PRadius:'''
**Particle radius
**Syntax: ''Value'', (meters)
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: ''Value'', (angle of the cone)
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: ''Filename''
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: ''Value Value Value Value Value'', Very Easy, Easy, Moderate, Hard, Very Hard respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+Muzzleglow:'''
**Defines the bitmap used t create the muzzle glow
**Syntax: ''Filename''
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: ''Value''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: ''Value''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: ''Value''

*'''+Range:'''
**Implemented before FS_Open 3.6.5
**Defines the maximum range where the beam still has any effect.
**Syntax: ''Value'', (meters)
*'''+Attenuation:'''
**Implemented before FS_Open 3.6.5
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: ''Value'', (from 0 - firing point to 1 - no effect)
***Default: 1

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
**'''+Width:'''
***Width of the section
***Syntax: ''Value'' (meters)
**'''+Texture:'''
***Texture for the section
***Syntax: ''Filename''
**'''+RGBA Inner:'''
***Defines the color and transparency of the center of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 255 255 255 255
**'''+RGBA Outer:'''
***Defines the color and transparency of the edges of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 150 150 150 10
**'''+Flicker:'''
***Defines how much the section flickers
***Syntax: ''Value'', value from 0 to 1
**'''+Zadd:'''
***Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
***Syntax: ''Value'' 
**'''+Tile Factor:'''
***Implemented before FS_Open 3.6.5
***Defines the beam texture tileing factor.
***Syntax: ''Value'', (from 0 to 1)
**'''+Translation:'''
***Implemented before FS_Open 3.6.5
***Defines the beam texture moveing stuff.
***Syntax: ''Value'', (from 0 to 1)

====$Pspew:====
*Implemented before FS_Open 3.6.5
*Defines a particle spew effect for the given weapon
*'''+Count:'''
**Defines???
**Syntax: ''Value''
*'''+Time:'''
**Defines???
**Syntax: ''Value'', (seconds)
*'''+Vel:'''
**Defines the created paricles speed relative to the weapon speed
**Syntax: ''Value'', (meters per second)
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: ''Value'', (meters)
*'''+Life:'''
**Defines???
**Syntax: ''Value'', (seconds)
*'''+Scale:'''
**Defines???
**Syntax: ''Value''
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: ''Filename''


====$Tag:====
*Allowed for secondary weapons
*Location: After $Impact Explosion Radius:
*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*Syntax: ''TAG level'' ''Value'', (seconds)


====$SSM:====
*Implemented before FS_Open 3.6.5
*Defines the weapons SSM index number:
*Syntax: ''Value''

====$FOF:====
*Implemented before FS_Open 3.6.5
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: ''Value'', (degrees)

====$Shots:====
*Implemented before FS_Open 3.6.5
*Defines the number of shots every time the weapon is fired.
*Syntax: ''Value'', (number of shots)

====$decal:====
*Implemented before FS_Open 3.6.5
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: ''Filename''
*'''+backface texture:'''
**Defines ???
**Syntax: ''Filename''
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: ''Value'', (meters)
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: ''Value''


==Weapon Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship of cruiser class or below for a short period of time

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Puncture"===
*Reduces hull damage by 25%

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon targetable with the B key, and the AI prefers to use it against large ships

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon

==="Particle Spew"===
*Makes the weapon projectile spew out particles

*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]


==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.

*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]


==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
*Gives this weapon a streaming effect. In effect weapon keeps firing when firing button is kept pressed.

==="puncture"===
*Reduces hull damage by 25%

==="supercap"===
*Makes weapon capable of causing real damage against ships with "supercap" flag.



==="countermeasure"===
*Defines the weapon as a countermeasure

==="Ballistic"===
*Implemented before FS_Open 3.6.5
*Defines the weapon as a ballistic weapon that needs ammunition.

==="pierce shields"===
*Implemented before FS_Open 3.6.5
*Causes weapons to penetrate shield without causing damage to it.

==="no pierce shields"===
*Implemented before FS_Open 3.6.5
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.

==="local ssm"===
*Implemented before FS_Open 3.6.5

==="tagged only"===
*Implemented before FS_Open 3.6.5
*Weapon can only be fired at tagged targets

==="beam no whack"===
*Implemented before FS_Open 3.6.5
*Disables beam whacking. Practically same as setting beam mass to zero.

==="cycle"===
*Implemented before FS_Open 3.6.5
*Causes weapon to alternate between firingpoints

==="small only"===
*Implemented before FS_Open 3.6.5
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)

==="same turret cooldown"===
*Forces the turrets to fire on the designated rate of fire on all difficulty levels


==Countermeasures==
*Usually not altered. Only one can exist

===$Name:===
*Name of the countermeasure
*Syntax: ''Name'', usually Type One

===$Velocity:===
*Defines the spped of the countermeasure, relative to the ship.
*Syntax: ''Value'', (meter per second)

===$Fire Wait:===
*Definies the minumum time between the countermeasure launches
*Syntax: ''Value'', (seconds)

===Lifetime===
*Countermeasure's life time is defined between with minimum and maximum lifetime
*'''$Lifetime Min:'''
**Syntax: ''Value'', (seconds)
*'''$Lifetime Max:'''
**Syntax: ''Value'', (seconds)

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: ''Value'', refers to sounds.tbl

===$Model:===
*Defines the used model file (.pof)
*Syntax: ''Filename.pof'', usually cmeasure01.pof

==Player Weapon Precedence==
*First the primary weapons are defined, from most powerful to least powerful, and then the same for secondaries
*Syntax: ( ''"Name" "Name"'')
*Example:

$Player Weapon Precedence: (
"UD-8 Kayser"
"Prometheus R"
"Subach HL-7"
"Harpoon"
"Tempest"
"Rockeye" )

==Sample==

#Primary Weapons
$Name: @Subach HL-7
+Title: XSTR("GTW Subach HL-7", 3243)
+Description:
XSTR( "Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text
+Tech Title: XSTR("Subach HL-7", 146)
+Tech Anim: Tech_Subach_HL-7
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: none
@Laser Bitmap: newglo9
@Laser Glow: 2_laserglow03
@Laser Color: 250, 0, 0
@Laser Color2: 0, 0, 250
@Laser Length: 10.0
@Laser Head Radius: 0.90
@Laser Tail Radius: 0.90
$Mass: 0.2
$Velocity: 450.0
$Fire Wait: 0.2
$Damage: 15
$Armor Factor: 0.9
$Shield Factor: 0.7
$Subsystem Factor: 0.3
$Lifetime: 2.0
$Energy Consumed: 0.20
$Cargo Size: 0.0
$Homing: NO
$LaunchSnd: 76
$ImpactSnd: 85
$Flags: ( "in tech database"
"player allowed"
"stream")
$Icon: iconSD4
$Anim: SD4
$Impact Explosion: none
#End
#Secondary Weapons
$Name: EMP Adv.
+Title: XSTR("GTM-14 EMP Adv.", 3396)
+Description:
XSTR( "Advanced Missile
Electromagnetic Pulse Weapon
General Purpose Suppression", 3397)
$end_multi_text
+Tech Title: XSTR("GTM-14 EM Pulse Adv.", 3398)
+Tech Anim: Tech_EMP
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: EMPulse2.pof
$Mass: 15.0
$Velocity: 275.0
$Fire Wait: 2.0
$Damage: 45
$Blast Force: 20.0
$Inner Radius: 80.0
$Outer Radius: 300.0
$Shockwave Speed: 120.0
$Armor Factor: 1.0
$Shield Factor: 0.8
$Subsystem Factor: 0.5
$Lifetime: 5.0
$Energy Consumed: 0.0
$Cargo Size: 4.0
$Homing: YES
+Type: ASPECT
+Turn Time: 1.0
+Min Lock Time: 2.0
+Lock Pixels/Sec: 70
+Catch-up Pixels/Sec: 100
+Catch-up Penalty: 30
$LaunchSnd: 118
$ImpactSnd: 88
$FlyBySnd: -1
$Rearm Rate: 2.0
$Flags: ( "player allowed"
"EMP")
$Trail:
+Start Width: 0.25
+End Width: 0.75
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.5
+Bitmap: MissileTrail04
$Icon: iconEMPulse
$Anim: ecm
$Impact Explosion: ExpMissileHit1
$Impact Explosion Radius: 10.0
$EMP Intensity: 375.0
$EMP Time: 20.0
#End
$Player Weapon Precedence: (
"Subach HL-7"
"EMP Adv." )

[[Category:Tables]]

Talk:Feature Requests

2005-12-27T01:10:23Z

WMCoolmon:

Excuse me, but should this be not in the SCP forum or the SCP website? Things like these do not beling to wikis. - [[User:TopAce|TopAce]] 19:15, 10 Dec 2005 (GMT)

The problem is that adding it to the SCP site would require a special PHP script, and a thread on the forums quickly becomes cluttered by irrelevant posts and discussions on the features. It also serves as a reference for feature requests...not the ideal solution, but the simplest one. [[User:WMCoolmon|WMCoolmon]] 01:09, 27 Dec 2005 (GMT)

Ships.tbl

2005-11-14T00:22:20Z

WMCoolmon: Added/updated various parts

Ships.tbl reference has was made following the older guide (originally written by GE) by
*Wanderer
*WMCoolmon
*The Trivial Psychic
*Contribute and include yourself here

==General Format==
*Ship.tbl is formed of several different sections:
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
**<nowiki>#</nowiki>'''Ship Classes'''
***Includes entries for every ship and also defines their attributes that are used in the game
***Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
**'''$Player Ship Precedence'''
***Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: ''Name''

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: ''Value', (degrees)

===$Radius Mult:===
*Defines something???
*Syntax: ''Value'', (multiplier)

===$Length:===
*Defines the lenght of the engine wash
*Syntax: ''Value'', (meters)

===$Intensity:===
*Defines the strenght of the engine wash
*Syntax: ''Value'', (blast effect)

===Example===

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Table Options==
*Retail options will look like this


*SCP options are marked with red color
**Most of the entries in ships.tbl have been made optional. Only entries that have to be filled are $Name:, $POF file: and $Flags:.


===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry.
*Syntax: ''name'',
**Example: ''Ulysses''

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: ''name'',
**Example: ''TFight''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship. More species have been enabled, and all of these are defined in species_defs.tbl.
*Syntax: ''Terran'', ''Shivan'' or ''Vasudan''
*Syntax: ''Name'', as defined in species_defs.tbl
**Example: ''Terran''

===Technical description===
List of discriptive terms for techroom and ship selection screens.
Number after the quotes refers to tstrings.tbl (does this have any function?)

+Type: XSTR("", -1)
+Maneuverability: XSTR("", -1)
+Armor: XSTR("", -1)
+Manufacturer: XSTR("", -1)
+Description: XSTR("", -1)
$end_multi_text
+Tech Description: XSTR("", -1)
$end_multi_text
+Length: 20 m
+Gun Mounts: 4
+Missile Banks: 1

===$POF file:===
*filename of the model file (.pof) at data/models folder
*Syntax: ''Filename.pof''
**Example: ''fighter01.pof''

===$Detail distance:===
*Definies the distance where the change between different Levels-Of-Details (LODs) occurs
*Syntax: ''(Value, Value, ...)'' (distances from the model in meters)
**Example: ''(0, 80, 300, 900)''

===$ND:===
*No Dim field field was used in FS1 for ship lights. Nowadays we use glowmaps.
*Syntax: ''Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
**Example: ''42, 42, 224''

===$Show damage:===
*No known function. Best left alone to avoid possible compatibility issues.
*Syntax: ''YES'' or ''NO'', usually YES

===$Density:===
*Has no function currently.
*Syntax: ''Value'', usually 1

===$Damp:===
*Damp affects how quickly you will accel/decel to your target velocity. Higher damp means slow acceleration and deceleration. The lower this number, the faster the ship responds. For example, specifying a value of 0.0 means there is no damping, in other words, people would say, "this has no physics, like Wing Commander." The more damping, the harder to control, but the more smoothly it moves.
*Syntax: ''Value''

===$Rotdamp:===
*Same thing, but for rotational movement.
*Syntax: ''Value''

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*Syntax: ''Value, Value, Value'', (meters per second) x-axis, y-axis, z-axis
**Example: ''0.0, 0.0, 80.0''

===$Rotation time:===
*Defines rotation times around the x, y, and z -axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis
*Syntax: ''Value, Value, Value'', (seconds per 360 degree turn) x-axis, y-axis, z-axis
**Example: ''3.0, 2.6, 5.0''

===$Rear Velocity:===
*Defines rear velocity
*Syntax: ''Value'', (meters per second) usually zero

===$Forward accel:===
*Number of seconds needed from full stop to maximum velocity
*Syntax: ''Value'', (seconds)

===$Forward decel:===
*Number of seconds needed from maxumum velocity to full stop
*Syntax: ''Value'', (seconds)

===$Slide accel: and $Slide decel:===
*Same for sliding as the $Forward accel: and $Forward decel: for normal movement.
*Syntax: ''Value'', (seconds) for both


===$Glide:===
*Allows gliding in game
*Syntax: ''YES'' or ''NO''

===$Warpin speed:===
*Sets the speed at which the ship warps in
*Syntax: ''Value''

===$Warpout speed:===
*Sets the speed at which the ship warps out from the game
*Syntax: ''Value''

===$Player warpout speed:===
*Sets the speed at which the player warps out from the game
*Syntax: ''Value'', can not be greater than $Max Oclk Speed:


===$Expl inner rad:===
*Radius at which the full explosion damage is done
*Syntax: ''Value'', (meters)

===$Expl outer rad:===
*Maximum radius at which any damage is done
*Syntax: ''Value'', (meters)

===$Expl damage:===
*Amount of damage done inside the inner radius
*Syntax: ''Value'', (damage value)

===$Expl blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: ''Value'', (blast effect)

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: ''YES'' or ''NO''

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: ''Value'', (meters per second)

===$Shockwave count:===
*Defines the number of shockwaves to spawned
*Syntax: ''Value''


===$Shockwave model:===
*Defines the textured model used as the ship's shockwave
*Syntax: ''name.pof''

===$Shockwave name:===
*Defines the name of the animation to used for the shockwave
*Syntax: ''Name''

===$Weapon Model Draw Distance:===
*Distance that external weapons are shown, ie missiles and such.
*Syntax: ''Value'', (meters)
**Default: ''200''


===Primary Weapons===

====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes). Each of the primary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry. 
*Syntax: ''( "Name" "Name" )''
*Syntax: ''( "Name" "Name" ) ( "Name" "Name" )''
**Example: ''( "Subach HL-7" "Prometheus R")''

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights. Each of the primary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry. 
*Syntax: ''( "Name" "Name" )''
*Syntax: ''( "Name" "Name" ) ( "Name" "Name" )''
**Example: ''( "Subach HL-D" "Prometheus D")''

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: ''( "Name" "Name" )''
**Example: ''( "Subach HL-7" "Prometheus R")''


====$PBank Capacity:====
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas. REQUIRES FLAG "ballistic primaries"
*Syntax: ''( Value, Value )'', usually all primary bank capacities are 1.
**Example: ''( 1, 1 )''

====$Show Weapon Models:====
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: ''( YES'' or ''NO )''
**Example: ''(YES YES)''


===Secondary Weapons===

====$Allowed SBanks:====
*Same for secondary weapons. Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry. 
*Syntax: ''( "Name" "Name" )''
*Syntax: ''( "Name" "Name" ) ( "Name" "Name" )''
**Example: ''( "Harpoon" "Hornet")''

====$Allowed Dogfight SBanks:====
*Same for secondary weapons. Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry. 
*Syntax: ''( "Name" "Name" )''
*Syntax: ''( "Name" "Name" ) ( "Name" "Name" )''
**Example: ''( "Harpoon D" "Hornet D")''

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: ''( "Name" "Name" )''
**Example: ''( "Harpoon" "Hornet")''

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: ''( Value, Value )'', (ammo capacity)
**Example: ''( 40, 40 )''


====$Show Weapon Models:====
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: ''( YES'' or ''NO )''
**Example: ''(YES YES)''


===$Shields:===
*Determines the shield strenght
*Syntax: ''Value'', (total hitpoints in all quadrants together)

===$Shield Color:===
*RGB value for shield color
*Syntax: "Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
**Example: ''100, 100, 255''
**Default: ''255, 255, 255''

===$Power Output:===
*The amount of energy available. The higher the output, the faster your weapons recharge.
*Syntax: ''Value''

===$Max Oclk Speed:===
*Maximum velocity with all energy diverted to engines
*Syntax: ''Value'', (meters per second)

===$Max Weapon Eng:===
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: ''Value''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: ''Value'', (hitpoints)
**Default: ''100''


===$Hull Repair Rate:===
*Repair rates for hull at percent per second
*Syntax: ''Value'', % of hitpoints repaired per second

===$Subsystem Repair Rate:===
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', % of hitpoints repaired per second
**Default ''0.01'', that is 1 % per second

===$Armor Type===
*Location: Right after the $Hitpoinrs:
*REQUIRES ADDITIONAL TABLE. Defines armor type used for the ship
*Syntax: ''Name'', as defined in armor.tbl


===$Flags:===
*See below
*Syntax: ''( "Flag" "Flag" )''
**Example: ( "fighter" "in tech database" )

===$AI Class:===
*Default AI class
*Syntax: ''AI name'', as defined in AI.tbl

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: ''YES'' or ''NO''
*'''+Aburn Max Vel:'''
**In same format as in $Max Velocity:
**Syntax: ''Value'', (meters per second)
*'''+Aburn For accel:'''
**Defined only as the forward acceleration. In same format as $Forward accel:
**Syntax: ''Value'', (seconds)
*'''+Aburn Fuel:'''
**Amount of afterburner fuel the ship has
**Syntax: ''Value'' (fuel units)
*'''+Aburn Burn Rate:'''
**Rate the fuel is consumed when afterburner is engaged (in units per seconds)
**Syntax: ''Value'' (fuel units per second)
*'''+Aburn Rec Rate:'''
**Rate the fuel is restored.
**Syntax: ''Value'' (fuel units per second)
*'''$Trails:'''
**Allows afterburner trails to be used
**'''+Bitmap:'''
***Texture used to draw the afterburner trail
***Syntax: ''Filename''
**'''+Width:'''
***Width of afterburner trail at the beginning of it (ie. the thruster end)
***Syntax: ''Value'', (in meters)
****Default: ''1.0''
**'''+Alpha:'''
***Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
***Syntax: ''Value''
****Default: ''1.0''
**'''+Life:'''
***How long the trail will last
***Syntax: ''Value'', (in seconds)
****Default: ''5.0''


===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: ''Value''

===$Scan time:===
*Time it takes to scan the ship
*Syntax: ''Value'', (milliseconds)
**Default: ''2000''

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: ''Name'', as defined in sounds.tbl

===$Closeup_pos:===
*How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
*Syntax: ''Value'', ''Value'', ''Value'', (X, Y and Z values)

===$Closeup_zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: ''Value'', (radians)


===$Topdown offset:===
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: ''Value'', (meters)


===$Shield_icon:===
*This .ani file must be at data/hud and included to the hud.tbl. Reference to the hud.tbl is no longer needed.
*Syntax: ''Filename''
**Example: ''shield-f01''

===$Ship_icon:===
*The icon used in ship selection. Ship model is used by default to generate the image.
*Syntax: ''Filename''
**Example: ''iconfighter01''

===$Ship_anim:===
*The glowing green grid animation used in ship selection. Ship model is used by default to generate the image.
*Syntax: ''Filename''
**Example: ''ssfighter01''

===$Ship_overhead:===
*The overhead view used in the weapons loadout. Ship model is used by default to generate the image.
*Syntax: ''Filename''
**Example: ''loadfighter01''

===$Score:===
*Points awarded for destroying the ship
*Syntax: ''Value'', (points)


===Customized Thruster Effects===
*Just a guess. I have no idea what these do. TBP, PLEASE HELP!
*'''Defines the primary thruster animation'''
**'''$Thruster Bitmap 1:'''
***Defines the animation for the standard drives
***Syntax: ''Filename''
**'''$Thruster Bitmap 1a:'''
***Defines the animation for the afterburner effect
***Syntax: ''Filename''
**'''$Thruster01 Radius factor:'''
***Defines???
***Syntax: ''Value''
****Default: ''1.0''
*'''Defines the secondary thruster animation'''
**'''$Thruster Bitmap 2:'''
***Defines the animation for the standard drives
***Syntax: ''Filename''
**'''$Thruster Bitmap 2a:'''
***Defines the animation for the afterburner effect
***Syntax: ''Filename''
**'''$Thruster02 Radius factor:'''
***Defines???
***Syntax: ''Value''
****Default: ''1.0''
*'''Defines the tertiary thruster animation'''
**'''$Thruster Bitmap 3:'''
***Defines the animation for the standard drives
***Syntax: ''Filename''
**'''$Thruster Bitmap 3a:'''
***Defines the animation for the afterburner effect
***Syntax: ''Filename''
**'''$Thruster03 Radius factor:'''
***Defines???
***Syntax: ''Value''
****Default: ''1.0''

===$Thruster Particles:===
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to three can be defined
**Syntax: ''Filename'', of ani file used
***Example: Exp04
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: ''Value'', (in meters)
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: ''Value'', (in meters)
*'''$Min created:'''
**Defines the minimum amount of particles created per second
**Syntax: ''Value'', (per second)
*'''$Max created:'''
**Defines the maximum amount of particles created per second
**Syntax: ''Value'', (per second)
*'''$Variance:'''
**Value that describes the randomnes or particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: ''Value'', (per second)

===$Thruster Particles:===
*Defines the alternative particle afterburners (requires at least 1 particle thruster)
*'''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thruster afterburners, up to three can be defined for afterburners so that in total six particle thrusters can be defines (3 standard + 3 afterburner).
**Syntax: ''Filename'', of ani file used
***Example: Exp04
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: ''Value'', (in meters)
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: ''Value'', (in meters)
*'''$Min created:'''
**Defines the minimum amount of particles created per second
**Syntax: ''Value'', (per second)
*'''$Max created:'''
**Defines the maximum amount of particles created per second
**Syntax: ''Value'', (per second)
*'''$Variance:'''
**Value that describes the randomnes or particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: ''Value'', (per second)


**'''$Stealth:'''
***Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar. This field is deprectated, and mods using 3.6.8 and above should use the "stealth" flag.
***Syntax: None
****Default: Off

**'''$Max decals:'''
***Defines: Maximum number of weapon decals on a ship
***Syntax: ''Number'', of decals on ship
****Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
*'''+Offset:'''
**The position of the contrail's head
**Syntax: ''Value'', ''Value'', ''Value'', (X, Y, Z values) relative to the centerpoint of the model
*'''+Start Width:'''
**The width of the contrail's head
**Syntax: ''Value'', (meters)
*'''+End Width:'''
**The width of the contrail's tail
**Syntax: ''Value'', (meters)
*'''+Start Alpha:'''
**The opacity of the contrail's head
**Syntax: ''Value'', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the contrail's tail
**Syntax: ''Value'', value between 0 and 1
*'''+Max Life:'''
**How long the contrail remains
**Syntax: ''Value'', (seconds)
*'''+Spew Time:'''
**????
**Syntax: ''Value'', (seconds)
*'''+Bitmap:'''
**The image to use for the contrail.
**Syntax: ''Filename''
***Example: Contrail01

===$Subsystem:===
*The name of the subsystem as defined in .pof file, % of ship's total hitpoints the subsystem has and rotation time (360 degrees) for multipart turrets. Note: Assinging zero to the %-hitpoint entry causes the subsystem to be without hitpoints, like fighterbays on some capital ships.
*[[Animation_Code|Animation Code]] can be applied to the subsystems that consist of submodels, like multipart turrets.
*Syntax: ''Subsystem name'' , ''Value'', (% of ships hitpoints) ''Value'', (seconds per 360 degree turn) subsystem name must be the same as described in model file (.pof). If you want to skip setting a field, leave the comma but don't enter the value
**Example: communications, 5, 0.0

====Turret====
*'''In addition''' to the previous entry all turrets require information concerning the weapon mounted to the turret. The entry can be either '''$Default PBanks''' for turret primaries (including beams) or '''$Default SBanks''' for turret secondaries
*[[Animation_Code#Setting_Turret_Angle|Animation Code]] can be used with multipart turrets.
*Syntax: ( "Name" )
**Example: ( "Subach HL-7" )
**Combined example for turret entry:

$Subsystem: turret01, 1.0, 1.0
$Default PBanks: ( "Terran Turret" )

====Engine====
*'''In addition''' to the previous entry all engines may use information concerning the engine wash. Engine washes are usually used only with larger vessels.
*Syntax: ''Name'', as defined in Engine Wash section
**Example: Default1000
**Combined example for engine entry:

$Subsystem: engine01, 5.0, 0.0
$Engine Wash: Default1000

====Sounds====
*'''$AliveSnd:'''
**Specifies a sound to play from the subsystem while it is not destroyed.
**Syntax: ''Sound'', where sound is the index or name of a sound in sounds.tbl
*'''$DeadSnd:'''
**Specifies a sound to play from the subsystem while it is destroyed.
**Syntax: ''Sound'', where sound is the index or name of a sound in sounds.tbl
*'''$RotationSnd:'''
**Does nothing for now
**Syntax: ''Sound'', where sound is the index or name of a sound in sounds.tbl

====AWACS====
*'''$AWACS:'''
**Set this subsystem's AWACS effect distance. (AWACS reveals stealthed ships, cuts through nebula fog.)
**Syntax: ''Number'', the maximum range of the AWACS

====Flags====
*'''+non-targettable'''
**Subsystem cannot be targetted
**Syntax: none

===Ships.tbl flags===

'''"player_ship"'''
*Makes it possible to player to fly the ship
'''"default_player_ship"'''
*Makes this ship as a default part of the loadout options in FRED
'''"in tech database"'''
*Includes ships description to the tech database from the beginning of tha campaing
'''"repair_rearm"'''
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly.
*Only one such vessel can be defined per species.
'''"fighter"'''
*Defines ship as a fighter and also sets the AI behaviour
'''"bomber"'''
*Defines ship as a bomber and also sets the AI behaviour
'''"transport"'''
*Defines ship as a transport and also sets the AI behaviour
'''"freighter"'''
*Defines ship as a freighter and also sets the AI behaviour
'''"cruiser"'''
*Defines ship as a cruiser and also sets the AI behaviour
'''"corvette"'''
*Defines ship as a corvette and also sets the AI behaviour
'''"capital"'''
*Defines ship as a capitalship and also sets the AI behaviour
'''"supercap"'''
*Defines ship as a super capitalship and also sets the AI behaviour
'''"cargo"'''
*Defines ship as a cargo crate and also sets the AI behaviour
'''"gas miner"'''
*Defines ship as a gas miner and also sets the AI behaviour
'''"awacs"'''
*Defines ship as a AWACS and also sets the AI behaviour
'''"navbuoy"'''
*Defines ship as a navbuoy and also sets the AI behaviour
'''"sentrygun"'''
*Defines ship as a sentrygun and also sets the AI behaviour
'''"drydock"'''
*Defines ship as a drydock and also sets the AI behaviour
'''"escapepod"'''
*Defines ship as a escapepod and also sets the AI behaviour
'''"knossos"'''
*Defines ship as a Knossos and also sets the AI behaviour
'''"dont collide invisible"'''
*Defines invisible textures as non-collideable (For example, a hangar entrace)
'''"no_collide"'''
*Defines ship as non-collideable, ie everything will go through it
'''"big damage"'''
*Limits the damage mage to the ship by non-huge weapons.
'''"no_fred"'''
*Ship will not appear in FRED.

'''"Ballistic primaries"'''
*Enables the ship to use ballistic primaries


'''"show ship"'''
*Will result in the player's ship model being rendered, when in cockpit mode


'''"generate icon"'''
*Creates a HUD icon from the model itself


'''"flash"'''
*Makes a flash when a ship dies


'''"surface shields"'''
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.


'''"no weapon damage scaling"'''
*Disables bombs doing different damage to different ship types


==Player Ship Precedence==
*Syntax: ( ''"Name" "Name"'')
*Example:

$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa"
)

==Sample==

#Default Player Ship
$Name: GTF Ulysses
#End
#Engine Wash Info
$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0
#End
#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF file: fighter01.pof
$Detail distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward accel: 2.0
$Forward decel: 1.5
$Slide accel: 0.0
$Slide decel: 0.0
$Expl inner rad: 25.0
$Expl outer rad: 55.0
$Expl damage: 15.0
$Expl blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan time: 2000
$EngineSnd: 128
$Closeup_pos: 0.0, 0.0, -22
$Closeup_zoom: 0.5
$Shield_icon: shield-f01
$Ship_icon: iconfighter01
$Ship_anim: ssfighter01
$Ship_overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0
#End
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa")

[[Category:Tables]]

Weapon expl.tbl

2005-11-13T21:52:56Z

WMCoolmon:

Originally, weapon_expl.tbl recorded the number of LODs for each explosion image. As of this writing, however, Fs2_open no longer needs or even uses weapon_expl.tbl; it detects LODs automatically, based on the filename.

Regardless, when FS2 searches for additional LODs, it will use the animation with the specified name for LOD0, and then use "NAME_#" for additional LODs.
*Example: ExpMissileHit1.eff (LOD 0), ExpMissileHit1_1.eff (LOD1)

==General Format==
There is really only one section of weapon_expl.tbl, and that section has exactly one entry type.
**<nowiki>#</nowiki>'''Start'''
***The list of all weapon effects entries. Note that it must be ended with "#End"

==Start==
===$Name:===
*Defines which explosion file this entry is for
*Syntax: ''filename''

===$LOD:===
*Defines how many LODs this explosion file has (up to 4)
*Syntax: ''Number'', of LODs.

Installing fs2 open

2005-11-12T10:33:32Z

WMCoolmon:

This guide assumes you already have a working copy of Freespace 2 installed. If not, see [[Installing Freespace 2]]. Also, this build assumes you do not use an installer. If you do, skip down to the part where it talks about configuring fs2_open.

== Step One: Understanding what you need ==

There are three main components that you need to get the most out of fs2_open.

First, the Launcher. This lets you configure the fs2_open executable for your particular system, in much the same way the original Freespace 2 launcher is used to configure it.

Next, the fs2_open build. This is the core game engine, a single executable file.

Finally, the MediaVPs. These contain all sorts of graphical improvements and are highly recommended. Version numbers of mediaVPs generally agree with the fs2_open build that they're supposed to be used with.

== Step Two: Getting the Launcher ==

Unless you are using an extremely old build, you will want to get Launcher 5.3. Otherwise, go with Launcher 4. To install either, extract it to your main Freespace 2 folder. (You can have both on your computer at the same time, although it's not recommended)

[http://scp.indiegames.us/download.php?view.133 Launcher 5.3 download page]

== Step Three: Choosing a build ==
There are two main types of fs2_open builds, at the time of this writing. A "build" is any executable built from source code. Any build may also be a debug build. (Debug builds usually have names that end with "_d" or "_dbg" or somesuch) If you don't know why you'd want to use a debug build, you're almost certainly better off not using one.

All builds should be extracted to your main Freespace 2 folder.

=== Official Releases ===
The first type is the "stable" release build. Depending on the version, there may be some minor bugs that made it into the final release. (In 3.6, you can't warp out in Very Easy difficulty; in 3.6.5, OGG music, and thus the MediaVP package mv_music, will cause a crash to desktop). However, they are more consistently stable than "recent builds", as they represent a group effort to get a stable build out, by all coders on the [[FSSCP]].

Additionally, some official release builds are available with installers. It's a good idea to get the most recent official release, even if you end up deciding to get a recent build anyway.

[http://scp.indiegames.us/download.php?list.8 Official release download page]

=== Recent Builds ===
Recent Builds are ones that individual coders release. These may be more stable than Official Releases, in some cases. Most of the time they're released to either test or showcase some particular new feature. If you're curious about how reliable a build is, your best bet is to check the original thread it was posted in and see what people's responses were.

[http://scp.indiegames.us/download.php?list.7 Recent builds download page]

== Step Four: Choosing your MediaVPs ==

There are a variety of different [[MediaVP]]s available for download. No matter what system you have, it should be able to support mv_core with no degradation in performance. This will enable a few interface improvements that require extra art.

mv_music should only be used with builds from April 2005 or after. mv_models should not be used on systems that do not support HT&L (video cards such as the TNT2 and below do not support HT&L). mv_adveffects should only be used if you have an extremely high-end system. (In the neighborhood of an X800 or 6800, and with a P4 or AMD64 processor.) The rest of the MediaVPs can be installed as your computer allows. (You may want to download them one at a time after you have configured fs2_open so you can get an idea of how much they will slow fs2_open down)

All mediaVPs go in your main Freespace 2 folder, unless you wish to continue to use the original Freespace 2 executables in the future. (See step six)

[http://scp.indiegames.us/download.php?list.2 MediaVP download page]

== Step Five: Configuring Everything ==

=== Basic setup ===

At this point, you have one final stage remaining before fs2_open is ready to go. Open up the Launcher. (It should be in your main Freespace 2 folder). Select the EXE you'd like to use by clicking the "Browse..." button at the top of the Launcher.

Next, ensure that the "Audio/Joystick" and "Network" tabs have the proper settings. (If you have trouble with your joystick not working properly in fs2_open, you may try the "Force 0" or "Force 1" options, which will force fs2_open to use the first or second joysticks, respectively.

=== Speech setup ===

If you are using Windows XP, or have the Speech API installed, fs2_open will be able to read briefings, techroom descriptions, and even ingame messages to you using computer-generated voices. Although no match for real voice acting, it is convenient when valid plot points are mentioned in the middle of combat. Speech in the various locations can be turned on and off by checking and unchecking the check boxes; you can choose which of the installed voices to use in fs2_open by changing the drop-down menu. As of this writing, fs2_open will only use the voice you choose for everything.

=== Video setup ===

On the "Video" tab, you can choose which API to use (OpenGL or Direct3D), what resolution to run in, and whether to use anti-aliasing (Multisampling) or not. Note that if you're using an ATI card, with Catalyst drivers above 4.3, shinemaps will not work in Direct3D. However, environment mapping will not work in OpenGL.

"Allow non standard modes" will let you choose resoltuions other than 1024x768 and 640x480. There may be some small graphics alignment errors, but these are generally small and virtually unnoticeable.

=== Features setup ===

This tab is where most of fs2_open's options can be toggled on and off. At the top is a readout of your current command line; you should include this in any debugging reports you make.

The next box, with the buttons "Select mod" and "No mod" allow you to choose a mod directory to use; files in the mod directory will be given precedence over other files, so you can easily switch between mods by installing them to different directories.

"Custom flags" allows you to add any command line flags that don't show up in the Launcher. This may be because they require additional arguments, as is the case with the "-fov" command line argument. For more information, see the [[Command Line Flags]] page.

Finally, the two boxes below this let you toggle the various new features in fs2_open, many of which are graphical improvements. Recommended options for midrange systems are "Enable specular", "Enable glowmaps", "Enable jpg,tga textures", "Enable more realistic lighting", and "Load only used weapons". (You may have to choose a different section in the drop-down box to get to some of these days). There are many, many more options, but these should get you started.

== Step Six: (Optional) Preserving Freespace 2 ==

At this point, if you try to start the original Freespace 2 executables, they'll likely crash at some point or other. To prevent this, do the following:

=== Move the mediaVPs to a mod dir ===
You can take advantage of the SCP's -mod feature and move the mediaVPs to a folder inside your main Freespace 2 folder; this folder can be named anything you like, such as "scp" or "mediaVPs". However, whenever you run Freespace 2, you must remember to select that folder as the current mod. If you want to play another mod, you must make use of the SCP's multiple mod feature.

=== Save any existing pilot files ===
Fs2_open upgraded the pilot files to allow for better mod handling in version 3.6.5. To prevent double entries from showing up, a new, upgraded version of the pilot file is created, and then the old one is deleted. To save your progress, copy all *.plr, *.csg, and *.css files that start with your pilot name. Then, rename the copies so that they're in the form of <your name>_scp. For example, my player file would be called "WMCoolmon_scp.plr". Then, only use the "_scp" versions when running fs2_open.

It's recommended you back up the originals as well, in case you accidentally click on the non-SCP version while in the SCP. (It should warn you that it's going to destructively convert them, however.)

Template:FS12 Ships

2005-06-12T06:12:11Z

WMCoolmon:

{| style="float: right;"
|[[Image:{{{1}}}]]
|-
|{{FS1 Ships}}
|-
|{{FS2 Ships}}
|}

GTB Medusa

2005-06-11T23:41:29Z

WMCoolmon:

{{FS12 Ships}}
*''Type'' - Heavy Bomber
*''Manufacturer'' - Han-Roland Corp.
*''Manuverablity'' - Poor
**''Rotation Damping'' - 0.55
**''Max Velocity'' - 0.0, 0.0, 50.0
**''Max Oclk Speed'' - 65.0
**''Rotation Time'' - 5.0, 4.5, 5.0
**''Rear Velocity'' - 0.0
**''Forward Acceleration'' - 4.0
**''Forward Deceleration'' - 2.0
**''Slide Acceleration'' - 0.0
**''Slide Deceleration'' - 0.0
*''Afterbuner'' - YES
**''Max Afterburner Velocity'' - 0.0, 0.0, 100.0
**''Afterburner Fuel'' - 300.0
**''Afterburner Burn Rate'' - 50.0
**''Afterburner Recharge Rate'' - 25.0
*''Armor'' - Heavy
**''Hitpoints'' - 350
**''Shields'' - 700
*''Length'' - 36 m
*''Gun Mounts'' - 2
**''Allowed FS1 Primaries'' - "ML-16 Laser" "Avenger" "Prometheus" "Leech Cannon" "S-Breaker"
**''Allowed FS2 Primaries'' - "Subach HL-7" "Prometheus S" "Prometheus R" "Lamprey" "Circe" "Maxim"
**''Default FS1 Primaries'' - "Avenger"
**''Default FS2 Primaries'' - "Prometheus R"
**''Max Weapon Energy'' - 100.0
*''Missile Banks'' - 3
**''Allowed FS1 Secondaries'' - "MX-50" "Hornet" "Phoenix V" "Stiletto" "Synaptic" "Tsunami" "EM Pulse" "Cluster Bomb"
**''Allowed FS2 Secondaries'' - "Rockeye" "Hornet" "Tornado" "Trebuchet" "Stiletto II" "Piranha" "Cyclops" "EMP Adv." "Infyrno"
**''Default FS1 Secondaries'' - "Hornet" "MX-50" "Tsunami"
**''Default FS2 Secondaries'' - "Hornet" "Cyclops" "Cyclops"
**''Secondary Capacity'' - 40, 80, 80
*''Power Output'' - 4.0
*''Countermeasures'' - 35

===FS1 Tech Room Description===
The Medusa is the standard attack bomber in the GTA. Its strong shielding and large secondary capacity make it the favored attack craft against cruiser class targets. As the first bomber to carry the Tsunami bomb, the Medusa is considered the staple of any bomber pilots career.

===FS2 Tech Room Description===
The GTB Medusa is the workhorse of the GTVA's bomber fleet. Its large bomb capacity enables it to take out cruiser-class warships, while its strong shielding ensures it can get close enough to deliver the punch. The first bomber to carry the potent Cyclops bomb, the Medusa is sure to be one of the highlights of a bomber pilot's career.

===Developer Notes===
Suitable for any size target. Carries most missile types, but few cannons. Armed with defensive turret, but still requires escort.

===Veteran Comments===

Template:FS12 Ships

2005-06-11T23:41:17Z

WMCoolmon:

{| style="float: right;"
|{{FS1 Ships}}
|-
|{{FS2 Ships}}
|}