SCASM 2.88

pseudo commands

command index:
 

back to main index

 

Set( )

Include( )

Macro( )

Mif( ), Melse, MifEnd

Grp( )

CopyRight( )

Uvar( )

Map( )

Error( )

VTrace( )

Internal section bits

This is a SCASM configuration command to set some internal flags and variables.

Similar to include files the text of an macro file is simply copied into your source file. But the advantage of an macro is that parameters can be passed to it. These parameters are inserted into the text during compile time. This makes it very easy to recycle scenery objects. If you want to design a house, it is usually a good idea to do this as a macro file and use the strings %1 and %2 for the latitude and longitude values of its position. Now you can put this house into your scenery simply by puting its actual Lat/Lon position as parameters one and two into the Macro() instruction. SCASM allows up to 30 parameters and each can have 32 characters.
Macros are allowed in visual scenery (section 9), dynamic scenery (section 15) and section 16. In SCASM 2.10 and later macros are allowed to contain other macros. This nesting is limited to 8 levels, and Include()'s are handled now as macros without parameters.
If a macro (file) name or a macro parameter contain spaces you have to use " to mark the begin and end of it (SCASM 2.15 and later).

This command writes the given position to a SCASM internal General Reference Point memory so it can be used later to calculate new positions.

There are two levels of stored positions, one defined outside of an Area() - EndA block and another defined inside. Every time an Area() command is compiled with direct Lat/Lon values, the position is stored into a temporary memory. This position is valid until the EndA command is executed. But the new Lat/Lon position is not stored if it is a calculated one, using the "d" or "r" option. This means that all calculations are done with the position defined outside the area block.
If you want a new base for calculations you have to use direct Lat/Long values in the Area() command or insert a new GRP() command following directly the Area() and use the same calculations. This new GRP will be deleted at the end of the area giving you back the old position defined outside the area block. You can use the stored position to calculate a new referencepoint position in every command that requires a Lat/Lon pair input.

Traditionaly many 3rd party scenery tools insert a text signature in the output file. Typically this is the name and version of the tool which generated this file. SCASM does the same. This instruction lets you add your own text to this signature.

This text has no effect to FS. This command should be used only once per source/BGL file. If this command is found more than once, only the last one is used (no error message). For this reason it is not a good idea to use it in a macro file.

No underscores '_' are needed for SPACE characters in the text.

This is an internal command to create and initialise an SCASM internal user variable. The names are case sensitive. This command has no effect to the BGL code. User variables can be used by experts for more flexible parameter calculations.

Note: variables which are defined within an Area() are only valid in this Area() and are deleted when the EndA statement is compiled. Other variables are always valid and are even visible from macros and includes.

SCASM can handle up to 200 user variables.

Besides user variables there are some other internal values which might be of interest:

This is another internal command which can be used to enable or suppress the map file generation for some parts of the source code file.
See also the "-m" command line option.

For more information please see the documentation which comes with the BGLTST.EXE program which uses this information to display the source code line(s) related to an detected error.

This pseudo command produces an error message and stops the compilation.

This instruction can be used as a reminder for changes you want to do later or to ensure that a specific source file (macro) is compiled with the correct SCASM version.

For example, if internal functions (version 2.02 and later) are used for the parameter calculations, you can use this instruction to notify the user that he needs an compiler update:

 ...
 mif( [$Version < 202] )
   Error
   ( You need at least SCASM 2.02 to compile this code )
 mifend
 ...
 Points( 0 -15  0  int[ %6 / 2 ]
   ...
 )
 ...

In this example the macro receives a parameter from the caller. If the %6 macro parameter has the value 15 the result would be 7.5. Since FS does not accept fractional numbers in point coordinates, an error message is normally generated. The int[ ] or the round[ ] function can now be used to convert the number format but these are not available in earlier versions.

This is an SCASM internal test command for debugging. It does not produce any code. You can use this command if you want to know the result of of some SCASM calculations.
The output is done to the standard error device, which is the console (DOS) window or the "SCAERROR.LOG" file.