Difference between revisions of "Stars.tbl"

From FreeSpace Wiki
Jump to: navigation, search
 
m
(16 intermediate revisions by 6 users not shown)
Line 1: Line 1:
Stars.tbl is used to define available background graphics, all the stars or suns that create colored light for the game and used debris animations.
+
{{TableVersion|5298}}
 +
 
 +
The '''stars.tbl''' is used to define available background graphics, all the stars or suns that create colored light for the game and used debris animations.
 +
 
 +
 
 +
This table is one of the [[Modular Tables]] and can be extended with xxx-str.tbm
 +
 
 +
[[Tables|List of Tables]]
  
 
==General Format==
 
==General Format==
Line 14: Line 21:
 
*<nowiki>#</nowiki>'''End'''
 
*<nowiki>#</nowiki>'''End'''
 
**Must be included to the end of the stars.tbl
 
**Must be included to the end of the stars.tbl
 +
  
 
===Background graphics===
 
===Background graphics===
 
*Background graphics use the names of their respective graphic files
 
*Background graphics use the names of their respective graphic files
*Background graphics can be defined in to different forms:
+
*Background graphics can be defined in two different forms:
 
**'''$Bitmap:'''
 
**'''$Bitmap:'''
***This entry type is used for transparent objects such as background nebulas
+
***This entry type is used for objects that use additive blending (intensity = transparency), such as nebulas and suns.
***Syntax: ''Name''
+
***Syntax: '''String''', filename
 
**'''$BitmapX:'''
 
**'''$BitmapX:'''
***This entry type is used for non transparent objects such as planets
+
***This entry type is used for the retail 'green transparency' objects (ie. 0,255,0 is transparent) in case of pcx files, and for full alpha channel blending for files that can have alpha channel (TGA and DXT3/DXT5 files). Use this to make the space around solid background objects (such as planets, big asteroids and such) transparent.
**Syntax: ''Name''
+
**Syntax: '''String''', filename
  
 
===Stars===
 
===Stars===
*Stars are defined with several different parameters. All parameters must be present.
+
*Stars are defined with several different parameters.
 
**'''$Sun:'''
 
**'''$Sun:'''
 
***Defines the name of the used star
 
***Defines the name of the used star
***Syntax: ''Name''
+
***Syntax: '''String''', filename
 
**'''$SunGlow:'''
 
**'''$SunGlow:'''
***Defines the graphics file used as a glow for the star
+
***Defines the bitmap or animation used as a glow for the star
***Syntax: ''Name''
+
***Syntax: '''String''', filename
 
**'''$SunRGBI:'''
 
**'''$SunRGBI:'''
***Defines the color of the sun as well as it's intensity
+
***Defines the color of the sun as well as its intensity
***Syntax: ''Value Value Value Value'', (red, green, blue and intensity respectively)
+
***Syntax: '''Color''', four '''floats''', 0.0 to 1.0, red, green, blue and alpha respectively
 +
 
 +
{{Table3610|
 +
:*'''$SunSpecularRGB:'''
 +
:**Defines the color of the sun specular lighting if it is to be different from '''$SunRGBI:''' values
 +
:**Syntax: '''Color''', three '''floats''', 0.0 to 1.0, red, green and blue respectively
 +
:*'''$Flare:'''
 +
:**Defines lens flare effect.
 +
:**'''+FlareCount:'''
 +
:***Defines number of lens flare effects attached to the sun, if the value is omitted then 1 is used as a default number of flare effects.
 +
:***Syntax: '''Integer'''
 +
:**'''$FlareTexture''N'':'''
 +
:***Defines the name of the bitmap used for the particular ( N ) lens flare texture.
 +
:***Syntax: '''String''', filename
 +
:**For each (defined in '''+FlareCount:''') lens flare effect
 +
:***'''$FlareGlow''X'':'''
 +
:****Defines the Xth lens flare effect.
 +
:****'''+FlareTexture:'''
 +
:*****Defines the texture used for the lens flare effect.
 +
:*****Syntax: '''Integer''', number of the texture defines in '''$FlareTexture''N'':'''.
 +
:****'''+FlarePos:'''
 +
:*****Defines the position of the lens flare effect, relative value
 +
:*****Syntax: '''Float'''
 +
:****'''+FlareScale:'''
 +
:*****Defines the scaling factor used for the lens flare effect.
 +
:*****Syntax: '''Float'''
 +
:*'''$NoGlare:'''
 +
:**Disables blinding effect from the sun.
 +
:**Usage: '''$NoGlare:''' without any parameters}}
  
 
===Non-nebula debris===
 
===Non-nebula debris===
Line 41: Line 77:
 
**'''$Debris:'''
 
**'''$Debris:'''
 
***Defines the animations used for the debris
 
***Defines the animations used for the debris
***Syntax: ''Name''
+
***Syntax: '''String'''
 +
 
  
 
===Nebula debris===
 
===Nebula debris===
Line 47: Line 84:
 
**'''$DebrisNeb:'''
 
**'''$DebrisNeb:'''
 
***Defines the animations used for the debris
 
***Defines the animations used for the debris
***Syntax: ''Name''
+
***Syntax: '''String'''
 +
 
  
 
==Sample==
 
==Sample==
 +
<pre>
 +
$Bitmap:      dneb01
 +
 +
#end
 +
 +
$Sun:        SunWhite
 +
$Sunglow:    Sunglow01
 +
$SunRGBI:    1.0 1.0 1.0 1.0
 +
 +
#end
 +
 +
$Debris:      debris01
 +
$Debris:      debris02
 +
$Debris:      debris03
 +
$Debris:      debris04
 +
 +
#end
 +
 +
$DebrisNeb:  gas
 +
$DebrisNeb:  gas
 +
$DebrisNeb:  gas
 +
$DebrisNeb:  gas
 +
 +
#end
  
    $Bitmap:      dneb01
+
#end
  #end
+
</pre>
    $Sun:        SunWhite
 
    $Sunglow:    Sunglow01
 
    $SunRGBI:    1.0 1.0 1.0 1.0
 
  #end
 
    $Debris:      debris01
 
    $Debris:      debris02
 
    $Debris:      debris03
 
    $Debris:      debris04
 
  #end
 
    $DebrisNeb:  gas
 
    $DebrisNeb:  gas
 
    $DebrisNeb:  gas
 
    $DebrisNeb:  gas
 
  #end
 
  #end
 
  
  
 
[[Category:Tables]]
 
[[Category:Tables]]

Revision as of 04:49, 19 July 2012

Revision information.....

FSO Revision: 5298
Note: Please update the version when the page is updated. If your edit had nothing to do with new code entries then please do not edit the version


The stars.tbl is used to define available background graphics, all the stars or suns that create colored light for the game and used debris animations.


This table is one of the Modular Tables and can be extended with xxx-str.tbm

List of Tables

General Format

  • Stars.tbl consist of several sections
  • Between different sections #End must be used
  • Background graphics
    • Defines the available background graphics (nebulas, planets, etc.)
  • Stars
    • Defines the stars
  • Non-nebula debris
    • Defines animation for non-nebula mode
  • Nebula debris
    • Defines animation for nebula mode
  • #End
    • Must be included to the end of the stars.tbl


Background graphics

  • Background graphics use the names of their respective graphic files
  • Background graphics can be defined in two different forms:
    • $Bitmap:
      • This entry type is used for objects that use additive blending (intensity = transparency), such as nebulas and suns.
      • Syntax: String, filename
    • $BitmapX:
      • This entry type is used for the retail 'green transparency' objects (ie. 0,255,0 is transparent) in case of pcx files, and for full alpha channel blending for files that can have alpha channel (TGA and DXT3/DXT5 files). Use this to make the space around solid background objects (such as planets, big asteroids and such) transparent.
    • Syntax: String, filename

Stars

  • Stars are defined with several different parameters.
    • $Sun:
      • Defines the name of the used star
      • Syntax: String, filename
    • $SunGlow:
      • Defines the bitmap or animation used as a glow for the star
      • Syntax: String, filename
    • $SunRGBI:
      • Defines the color of the sun as well as its intensity
      • Syntax: Color, four floats, 0.0 to 1.0, red, green, blue and alpha respectively


FS2 Open 3.6.10:
  • $SunSpecularRGB:
    • Defines the color of the sun specular lighting if it is to be different from $SunRGBI: values
    • Syntax: Color, three floats, 0.0 to 1.0, red, green and blue respectively
  • $Flare:
    • Defines lens flare effect.
    • +FlareCount:
      • Defines number of lens flare effects attached to the sun, if the value is omitted then 1 is used as a default number of flare effects.
      • Syntax: Integer
    • $FlareTextureN:
      • Defines the name of the bitmap used for the particular ( N ) lens flare texture.
      • Syntax: String, filename
    • For each (defined in +FlareCount:) lens flare effect
      • $FlareGlowX:
        • Defines the Xth lens flare effect.
        • +FlareTexture:
          • Defines the texture used for the lens flare effect.
          • Syntax: Integer, number of the texture defines in $FlareTextureN:.
        • +FlarePos:
          • Defines the position of the lens flare effect, relative value
          • Syntax: Float
        • +FlareScale:
          • Defines the scaling factor used for the lens flare effect.
          • Syntax: Float
  • $NoGlare:
    • Disables blinding effect from the sun.
    • Usage: $NoGlare: without any parameters

Non-nebula debris

  • There must always be four (4) of these
    • $Debris:
      • Defines the animations used for the debris
      • Syntax: String


Nebula debris

  • There must always be four (4) of these
    • $DebrisNeb:
      • Defines the animations used for the debris
      • Syntax: String


Sample

$Bitmap:      dneb01

#end

$Sun:         SunWhite
$Sunglow:     Sunglow01
$SunRGBI:     1.0 1.0 1.0 1.0

#end

$Debris:      debris01
$Debris:      debris02
$Debris:      debris03
$Debris:      debris04

#end

$DebrisNeb:   gas
$DebrisNeb:   gas
$DebrisNeb:   gas
$DebrisNeb:   gas

#end

#end