Difference between revisions of "Credits.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(Sample)
(Added the image number specification, and verified that the wiki is up-to-date with r9770)
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{TableVersion|9027}}
+
{{TableVersion|9770}}
 +
 
 +
The '''credits.tbl''' is a table for defining the text displayed in the credits screen.
  
'''Credits.tbl''' is a table for defining the text displayed in the credits screen.
 
  
 
This table is one of the [[Modular Tables]] and can be extended with xxx-crd.tbm
 
This table is one of the [[Modular Tables]] and can be extended with xxx-crd.tbm
 +
 +
[[Tables|List of Tables]]
  
 
==Flags==
 
==Flags==
 
*These go before the rest of the credits. They are applied in the order the tables are parsed so previous entries are overwritten by new entries.  
 
*These go before the rest of the credits. They are applied in the order the tables are parsed so previous entries are overwritten by new entries.  
  
===$Music===
+
===$Music:===
 
{{Table3615|
 
{{Table3615|
 
*Sets the music to be played during the credits.
 
*Sets the music to be played during the credits.
Line 15: Line 18:
 
*Syntax: '''''String'''''}}
 
*Syntax: '''''String'''''}}
  
===$Start Image Index===
+
===$Number of Images:===
 +
{{Table371|
 +
*Sets the number of images that are cycled during the credits.
 +
*Defaults to the retail value of 46 (0-45).
 +
*Syntax: '''''Integer'''''}}
 +
 
 +
===$Start Image Index:===
 
{{Table3613|
 
{{Table3613|
 
*Sets the image index that the credits image scroll will start with.
 
*Sets the image index that the credits image scroll will start with.
 
*Defaults to random number.
 
*Defaults to random number.
*Syntax: '''''Interger'''''}}
+
*Syntax: '''''Integer'''''}}
  
===$Text scroll rate===
+
===$Text scroll rate:===
 
{{Table3615|
 
{{Table3615|
 
*Sets the scroll rate of the text in pixels per second
 
*Sets the scroll rate of the text in pixels per second
Line 27: Line 36:
 
*Syntax: '''''Float'''''}}
 
*Syntax: '''''Float'''''}}
  
===$Artworks display time===
+
===$Artworks display time:===
 
{{Table3615|
 
{{Table3615|
 
*Sets the time a single image is displayed without fadein and -out times.
 
*Sets the time a single image is displayed without fadein and -out times.
Line 34: Line 43:
 
*Syntax: '''''Float'''''}}
 
*Syntax: '''''Float'''''}}
  
===$Artworks fade time===
+
===$Artworks fade time:===
 
{{Table3615|
 
{{Table3615|
 
*Sets the time spent for fading an image.
 
*Sets the time spent for fading an image.
Line 41: Line 50:
 
*Syntax: '''''Float'''''}}
 
*Syntax: '''''Float'''''}}
  
===$SCP Credits position===
+
===$SCP Credits position:===
 
{{Table3615|
 
{{Table3615|
 
*Specifies the position where the default SCP credits appear
 
*Specifies the position where the default SCP credits appear

Revision as of 05:19, 5 September 2013

Revision information.....

FSO Revision: 9770
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 credits.tbl is a table for defining the text displayed in the credits screen.


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

List of Tables

Flags

  • These go before the rest of the credits. They are applied in the order the tables are parsed so previous entries are overwritten by new entries.

$Music:

FS2 Open, 3.6.16:
  • Sets the music to be played during the credits.
  • String value is from music.tbl.
  • Defaults to 'Cinema'
  • Syntax: String

$Number of Images:

FS2 Open, 3.7.2:
  • Sets the number of images that are cycled during the credits.
  • Defaults to the retail value of 46 (0-45).
  • Syntax: Integer

$Start Image Index:

FS2 Open, 3.6.14:
  • Sets the image index that the credits image scroll will start with.
  • Defaults to random number.
  • Syntax: Integer

$Text scroll rate:

FS2 Open, 3.6.16:
  • Sets the scroll rate of the text in pixels per second
  • Defaults to 15
  • Syntax: Float

$Artworks display time:

FS2 Open, 3.6.16:
  • Sets the time a single image is displayed without fadein and -out times.
  • Specified in seconds
  • Defaults to 9
  • Syntax: Float

$Artworks fade time:

FS2 Open, 3.6.16:
  • Sets the time spent for fading an image.
  • Specified in seconds
  • Defaults to 1
  • Syntax: Float

$SCP Credits position:

FS2 Open, 3.6.16:
  • Specifies the position where the default SCP credits appear
  • Defaults to 'Start'
  • Syntax: String, one of:
    • Start
    • End

Format

  • Table consists of header entries followed by the list of people under that header.
  • Header:
    • Syntax: XSTR("String", -1), Header
    • Example: XSTR("Lead Programmer:", -1)
  • List of names can be added under each header (not required).

Sample

$Start Image Index: 00
$Text scroll rate: 17.0
$Artworks display time: 6.5
$Artworks fade time: 1.5
$SCP Credits position: end

XSTR("Lead Programmer:", -1)

Dave Baranec


XSTR("Programming:", -1)

Dave Andsager
Jeff Farris
Neil Kumar

#end