Comment Out

  • There are several ways to comment out certain areas in the Omsi files. Commenting out is necessary to block certain areas from reading access for test purposes without deleting or changing the content.

    1. Basics

    In many files, you can block read access to individual areas for Omsi. You do not need to delete or modify the whole area. This option is useful for error or object search. Not every possibility is suitable for all files. If you want to search for a certain object from the bus and don't know the exact object name, you can comment out single objects from the vehicle or map objects. If you don't have the desired objects, remove the comment and the objects will reappear.

    1.1. In addition to the files used in Omsi (see also File Formats), some files are also configuration files:

    busfile.bus

    Scenery objects.sco

    vehicle files.ovh

    Definition file for humans.hum

    model.cfg

    envir.cfg

    sound.cfg

    passengercabin.cfg

    pathdata.cfg

    Yard file.hof

    font file.oft


    Basically, you can recognize a configuration file by the files that can be opened with a simple editor and in which [commands] must be placed in square brackets. These commands are only valid if they are placed at the beginning of a line and have been entered alone in a line. All deviations from this basic rule lead to the fact that the command cannot be recognized and leads to errors.

    1.2. Possibilities to comment out

    There are three ways to lock individual commands or entire areas in configuration files from read access in Omsi


    Comment out with the command -<DISABLED>- & -<ENABLED>-

    Commenting out using the Tab key

    Commenting out by means of a preceding character


    1.2.1. Disabled/Enabled comment

    With the help of this command, larger areas can be completely blocked from reading access. This command is then valid for all following entries until the command is cancelled by a counter command. This option is only available in the configuration files.


    Example:

    ...

    [valid range]

    ...

    -<DISABLED>-

    ...

    [invalid area]

    ...

    [valid range]


    However, this possibility exists only in the configuration files.

    1.2.2. Commenting out using the Tab key

    Another option is to use the Tab key. Commands that must be enclosed in square brackets are generally only recognized if they are placed at the beginning of a line, and only if they are alone in a line. If they are not at the beginning of the line, these commands are not recognized and Omsi ignores them completely.


    Code
    Code:Example
    [valid range]
    ...
            [invalid area]
    ...
    [valid range]
    ...

    1.2.3. Commenting out by means of characters

    To avoid errors when reading out to files, you can exclude areas from reading. In addition, the following option offers the possibility to add comments to files to explain certain processes or to enter information, which gives others the possibility to learn from the areas or to change them specifically. Contrary to the already presented possibilities, it is possible to exclude single lines from reading access to avoid errors caused by file processing. Therefore this possibility works not only in configuration files, but also in all other file formats, like scripts. Here a character is placed at the beginning of the line, which excludes the line from reading.


    In contrast to configuration files, where all three options can be implemented, only commenting out with quotation marks is allowed in scripts.


    Example:

    [valid range]

    ...

    '

    [invalid range]

    ...

    [valid range]

    ...


    'excluded and invalid line

    ...

    valid line or string

    ...


    'This line is only for user information

    ...

    (L.L.valid_variable)


    '(L.L.invalid_variable) &&

    (S.L.valid_variable)

    ...


    Important:

    Please note! In the font file.oft, there is no way to lock lines before reading, with a superscript or other character, if these lines are under a [command]. Thus, the superscript ' also counts as a usable character that can be read.

Teilen

CC BY-SA 4.0

Sämtliche Inhalte unseres OMSI-Wiki sind unter Creative Commons Namensnennung & Weitergabe unter gleichen Bedingungen (CC BY-SA 4.0) lizensiert.