SCASM 2.95

FS9 extensions

  

command index:
 
back to main index
 
Header( )
Name( )
Airport( )
AptEnd( )
Tower( )
Fuel( )
Delete_Airport( )
Runway( )
OffsetThreshold( )
Blastpad( )
Overrun( )
AproachLights( )
VASI( )
Helipad( )
Start( )
Com( )
TaxiwayPoints( )
TaxiwayParking( )
TaxiwayPath( )
TaxiwayNames( )
Apron( )
 
Nav( )
Loc( )
GP( )
DME( )
NavEnd( )
Marker( )
NDB( )
 
LibraryObject( )
Windsock( )
Effect( )
TaxiwaySign( )
Trigger( )
 
Examples

Document status: provisional

Some instruction uses "named parameters" for optional parameters. Named parameters have the following form:
Name="value"
Don't forget the quote or equal sign.

If not mentioned otherwise all distances and altitudes are in meters.

It is recommended to enter the data of assembled objects like Airport() or Runway() in the same sequence as they appears in this document.

 

2.95 - FS2004
Header( ID )
 

The Header command is required for all BGL Files. The special 0x201 value is now used to switch to the new FS9 BGL file format.

ID 0x201 switches FS9/FS2004 file format


TOP 

2.95 - FS2004
Name( "text" )
 

This command is used to add a name string to complex commands (i.e. navaids).


TOP 

2.95 - FS2004
Airport( lat lon alt magvar "ID" "region" )
 

This command starts a data section collecting all data asociated with an airport.

lat Latitude
lon Longitude
alt Altitude
magvar Magnetic variation
ID ICAO ID of the airport
region Region code (optional). Enter "" if not used.


TOP 

2.95 - FS2004
AptEnd
 

This command indicates the end of an airport block. All airport related commands are only allowed between the Airport() and AptEnd commands.


TOP 

2.95 - FS2004
Names( "region" "country" "state" "city" "airport" )
 

Adds names to the database. Use "" for empty strings.
This command is a hack. In future versions this command may be replaced by named parameters.

region Region string - optional
country Country - mandatory
state State - optional
city City - mandatory
airport Airport - mandatory


TOP 

2.95 - FS2004
Tower( lat lon alt )
 

Adds tower data to the airport.

lat Latitude
lon Longitude
alt Altitude - it seems this value is not used. Always found 0


TOP 

2.95 - FS2004
Fuel( flags )
 

Adds fuel data to an airport.

fuel Fuel type bitmask (32 bit hex value).


TOP 

2.95 - FS2004
Delete_Airport( flags 0 0 0 )
 

Deletes specific elements of this airport. This is only a minimal version of this instruction.
To be expanded later.

flags Delete flags / bits:
0: all approaches
1: all apron lights
2: all aprons
3: all frequencies
4: all helipads
5: all runways
6: all starts
7: all taxiways
0 Dummy values for later expansions.


TOP 

2.95 - FS2004
Runway( lat lon <list_of_named_parameters> )
 

Adds a basic runway structure to the airport.

lat Latitude
lon Longitude

Named parameters / format: Name="value"

Altitude Runway altitude
Surface Runway surface type:
CONCRETE, GRASS, WATER, ASPHALT, DIRT, SAND, SNOW, ICE
RwyID1
RwyID2		 Primary and secondary runway ID number
RwyDes1
RwyDes2		 Primary and secondary runway designator. (L, R, C, W)
Length Runway length
Width Runway width
Heading Runway heading
ILSID1
ILSID2		 ICAO ID of primary / secondary ILS if present.
Markings Flag bits for runway markings:
Lights Flag bits for runway lights:
0 - 1 = edge ( 01=low, 10=medium, 11=high )
2 - 3 = center ( 01=low, 10=medium, 11=high )
5 = center lights are red
others unknown
Pattern_Altitude Pattern altitude
Pattern_Flags Pattern flag bits (0 = YES / LEFT):
0: primary takeoff
1: primary landing
2: primary pattern
3: secondary takeoff
4: secondary landing
5: secondary pattern

TOP 

If these runway extension commands are used they must follow immediately the runway they belong to.

2.95 - FS2004
OffsetTrhreshold( type surface length width )
 

Adds a pre threshold area to the runway.

type 1 or PRIMARY
2 or SECONDARY
surface Surface type as defined in Runway().
length Length
width Width

TOP 

2.95 - FS2004
Blastpad( type surface length width )
 

Adds a blastpad to the runway.

type 1 or PRIMARY
2 or SECONDARY
surface Surface type as defined in Runway().
length Length
width Width

TOP 

2.95 - FS2004
Overrun( type surface length width )
 

Adds an overrun area to the runway.

type 1 or PRIMARY
2 or SECONDARY
surface Surface type as defined in Runway().
length Length
width Width

TOP 

2.95 - FS2004
ApproachLights( type system strobes )
 

Adds approach lights to the runway.

type 1 or PRIMARY
2 or SECONDARY
system Aproach light system:
NONE
ODALS
MALSF
MALSR		 SSALF
SSALR
ALSF1
ALSF2		 RAIL
CALVERT
CALVERT2
MALS		 SALS
SSALS
strobes Number of strobes.

TOP 

2.95 - FS2004
VASI( type system x_bias z_bias spacing pitch )
 

Adds a VASI system to the runway

type 1 or PRIMARY
2 or SECONDARY
system Aproach light system:
VASI21
VASI31
VASI22
VASI32		 VASI23
VASI33
PAPI2
PAPI4		 TRICOLOR
PVASI
TVASI
BALL		 APAP
x_bias X offset from runway center
z_bias Z offset from runway center
spacing Element spacing
pitch Pitch angle

TOP 

2.95 - FS2004
Helipad( lat lon <list_of_named_parameters> )
 

Defines an Helipad

lat Latitude
lon Longitude
Altitude Altitude
Surface Surface types as defined in Runway
Length Length
Width Width
Heading Heading
Type Helipad type flag bits.
Color Color code, can only be entered as 32bit hex value (0x...).


TOP 

2.95 - FS2004
Start( lat lon <list_of_named_parameters> )
 

Defines an start position.

RwyID Runway ID number.
RwyDes Runway designator: L, R, C, W
Type Type of start position: RUNWAY, WATER, HELIPAD, 1, 2, 3
Altitude Altitude
Heading Heading


TOP 

2.95 - FS2004
Com( "type" frequency "name" )
 

Defines an communication transmitter

type Communication type:
ATIS, MULTICOM, UNICOM, CTAF, GROUND,
TOWER, CLEARENCE, APPROACH, DEPARURE, CENTER, FSS, AWOS, ASOS
frequency Communication frequency in MHz (Mc).
name Name text


TOP 

2.95 - FS2004
TaxiwayPoints( "type" "flags" LAT LON ... )
 

This command defines a list of taxiway points.

LAT Latitude
LON Longitude
type Type of taxiway point. Allowed values are:
1 or NORMAL
2 or HOLD_SHORT
4 or ILS_HOLD_SHORT


TOP 

2.95 - FS2004
TaxiwayParking( lat lon rad hdg "type" "name" "num" "pb" "cod" ... )
 

This command defines a list of parking positions. Repeat the whole parameter list for every position.

lat Latitude
lon Longitude
rad Radius
hdg Heading
type Type of this parking position. Allowed values are:
RAMP GA
RAMP GA SMALL
RAMP GA MEDIUM
RAMP GA LARGE
RAMP CARGO		 RAMP MIL CARGO
RAMP MIL COMBAT
GATE SMALL
GATE MEDIUM
GATE HEAVY
DOCK GA
name Name of the parking position. Values are:
NONE
PARKING
N PARKING
NE PARKING
E PARKING
SE PARKING
S PARKING
SW PARKING		 W PARKING
NW PARKING
GATE
DOCK
GATE A
...
GATE Z
num Number of the parking position. Values 0 ... 4095
pb Pushback codes: NONE, LEFT, RIGHT, BOTH
cod Airline codes, up to four letters. If more than one code is needed use a comma to separate them. Use empty string "" if no airline code is available.


TOP 

2.95 - FS2004
TaxiwayPath( start end type des name flags surface width limit ... )
 

This command defines a list of taxiway pathes. Repeat the whole parameter list for every single path.

start Start index.
end End index.
type Type of path
TAXI
RUNWAY
PARKING
PATH
CLOSED
des Designator. Only used if taxiway path type is RUNWAY. Values are:
0, NONE, LEFT, RIGHT, CENTER
name Name or runway number.
Index number to the name table defined in TaxiwayNames().
If taxiway path type is RUNWAY this is the runway number.
flags Flags for taxiway paintings.
bit 0:centerline
bit 1:centerline lighted
bit 2 - 3: left edge
00=none
01=solid
10=dashed
11=solid dashed
bit 4:left edge lighted
bit 5 - 6: right edge
00=none
01=solid
10=dashed
11=solid dashed
bit 7:right edge lighted
surface Surface type as defined in Runway()
width Taxiway width.
limit Taxiway weight limit. Usual value is 500000.


TOP 

2.95 - FS2004
TaxiwayNames( "name" ... )
 

Defines a list of taxiway name strings. If taxiways are defined you must define at least one empty string. The strings are acessed by their index numbers starting with 0.

name Taxiway name string with up to 7 characters.

TOP 

2.95 - FS2004
Apron( surface flags vertex_list / triangle_list )
 

Defines an apron. Note that the two lists are separated by the "/" character!

surface Apron surface type as defines in Runway().
flags Drawing flags, usualy set to 3.
bit 0: draw surface
bit 1: draw detail
vertex_list List of vertices. Every vertex is defined by a pair of latitude and longitude coordinates.
triangle_list List of triangles. Every triangle consist of a set of 3 index numbers referring to the vertex list. The index of the first vertex is 0.

TOP 

 

Navaids like VOR or ILS are consisting of different elements. This is the basic element containing data shared by all of them.

type 1 = VOR TERMINAL
2 = VOR LOW
3 = VOR HIGH
4 = ILS
5 = VOR VOT
flags bit 1 = 0 -DME only!
bit 2 = backcourse
bit 3 = glideslope present
bit 4 = DME
bit 5 = NAV true
LAT Latitude
LON Longitude
frq Frequency in Mc
rng Range of this navaid. Default unit is meters. You can add one of the following abbreviations to use others: m, km, nm, ft
magvar Magnetic variation
ID ICAO ID
reg/apt Region code (optional)
Airports ICAO code (optional) if this navaid is attached to an airport
The "/" is only required if the region code is used.

TOP 

2.95 - FS2004
Loc( rwynum heading width )
 

Locator for ILS

rwynum Runway number
heading Heading of the ILS locator beam.
width Width of the locator beam in degrees.


TOP 

2.95 - FS2004
GP( lat lon alt range pitch )
 

Glide Path (Glide Slope) for ILS.

lat Latitude
lon Longitude
alt Altitude
range Range of the glideslope transmitter
pitch Glideslope angle

TOP 

2.95 - FS2004
DME( lat lon alt range )
 

This command adds a DME to the navaid.

lat Latitude
lon Longitude
alt Altitude
range Range of DME transmitter

TOP 

2.95 - FS2004
Name( "text" )
 

Name string of this navaid (mandatory). See Name(...) for details.


TOP 

 

This command indicates the end of an navaid group.


TOP 

2.95 - FS2004
Marker( lat lon alt heading "type" "ID" "reg/aptID" )
 

Marker beacon.

lat Latitude
lon Longitude
alt Altitude
heading Heading of the runway this marker belongs to.
type Marker type:
IM or INNER
MM or MIDDLE
OM or OUTER
BC or BACKCOURSE
ID Marker ID code
reg/aptID Region and airport ID code. Use "" if not ued!

TOP 

2.95 - FS2004
NDB( "type" frq lat lon alt rng magvar "id" "reg/apt" "name" )
 

This command defines an NDB (non directional beacon).

type NDB type:
COMPASS_POINT
MH
H
HH
frq Frequency in kc (kHz).
lat Latitude
lon Longitude
alt Altitude in meters
rng Range
magvar Magnetic variation
id ID code of this NDB
reg/apt Region code and airport ID. Use "" if not used.
name Name string of this NDB.

TOP 

Objects

All these objects must be used outside an Airport() - EndApt sequence.

2.95 - FS2004
LibraryObject( lat lon alt AGLflg pitch bank heading complex GUID scale )
 

This command inserts an object from an FS library file.

lat Latitude
lon Longitude
alt Altitude
AGLflg Flag indicating altitude is AGL (=1) or not.
pitch Pitch angle
bank Bank angle
heading Heading angle
complex Image comlexity. Valid numbers are:
0 = very sparse
1 = sparse
2 = normal
3 = dense
4 = very dense
GUID Objects GUID identifier, split up into four 32bit hex numbers.
scale Scale factor of this object.

TOP 

2.95 - FS2004
Windsock( lat lon alt AGLflg pitch bank heading complex height length pcolor scolor light )
 

Defines an FS standard windsock.

lat Latitude
lon Longitude
alt Altitude
AGLflg Flag indicating altitude is AGL (=1) or not.
pitch Pitch angle
bank Bank angle
heading Heading angle
complex Image comlexity. Valid numbers are:
0 = very sparse
1 = sparse
2 = normal
3 = dense
4 = very dense
height Pole height in meters.
length Sock length in meters
pcolor Pole color code. Enter it as 32bit hex value.
scolor Sock color code. Enter it as 32bit hex value.
light Light flag. 1 indicates windsock is lighted.

TOP 

2.95 - FS2004
Effect( lat lon alt AGLflg pitch bank heading complex "name" "params" )
 

This command inserts an effect. Effect files are defined eslwhere.

lat Latitude
lon Longitude
alt Altitude
AGLflg Flag indicating altitude is AGL (=1) or not.
pitch Pitch angle
bank Bank angle
heading Heading angle
complex Image comlexity. Valid numbers are:
0 = very sparse
1 = sparse
2 = normal
3 = dense
4 = very dense
name Name of the effect.
params Parameter string of the effect. Use "" (empty string) if effects needs no parameters.

TOP 

2.95 - FS2004
TaxiwaySign( lat lon
   dlon dlat hdg size justification "label"
   ...
)
 

This command adds a list of taxiway signs to the object section. Repeat the parameters in the second line for every single sign.

lat Latitude
lon Longitude
dlon Longitude offset (x difference)
dlat Latitude offset (z difference)
hdg Heading
size Size of the taxiway sign. Allowed size values are 1 ... 5
justification Justification:
1, R, RIGHT
2, L, LEFT
label Text for this sign:
Besides alphanumeric characters several special characters are used:
[ ] / | \ < ` ' ^ >
A typical string is: l[A]m16

TOP 

2.95 - FS2004
Trigger( lat lon alt AGLflg pitch bank heading complex type=0 fuelmsk x1 z1 ... xn zn )
Trigger( lat lon alt AGLflg pitch bank heading complex type=1 wtype hdg scalar x1 z1 ... xn zn )
 

This command inserts an trigger record. The trigger area is typicaly defined by 4 points (x? y? pairs).

lat Latitude
lon Longitude
alt Altitude
AGLflg Flag indicating altitude is AGL (=1) or not.
pitch Pitch angle
bank Bank angle
heading Heading angle
complex Image comlexity. Valid numbers are:
0 = very sparse
1 = sparse
2 = normal
3 = dense
4 = very dense
type Trigger type:
0 = refuel/repair
1 = weather
fuelmsk Fuel type and availability bitmask, 32bit hex value.
x? X offset from referencepoint
y? Y offset from referencepoint
wtype Weather type
1 = ridge lift
2 = unidirectional turbulence
3 = directional turbulence
4 = thermal
hdg Heading
scalar Weather effect scalar. Valid range is 0.0 to 1000.0

TOP 

2.95 - FS2004
Fuel type and availability bitmask
 

Fuel type bitmask as used in the Airport() and Trigger() data structures.
There are 2 bits for every type except the two last ones and they are coded as follows:
00 = NO, 01 = UNKNOWN, 10 = PRIOR REQUEST, 11 = YES.

bits fuel type
0 - 1 73
2 - 3 87
4 - 5 100
6 - 7 130
8 - 9 145
10 - 11 MOGAS
12 - 13 JET
14 - 15 JETA
16 - 17 JETA1
18 - 19 JETAP
20 - 21 JETB
22 -23 JET4
24 - 25 JET5
26 - 29 n/a
30 piston type
31 jet type

TOP 

 

2.95 - FS2004
Examples:
 

Example source ....

Example 1 ....

 

Example source ....

Example ....

    
TOP © Manfred Moldenhauer