Howto:Add blackout and redout settings: Difference between revisions

Jump to navigation Jump to search
Moving up the section with instructions for the new system; Adding link to additional source file, though I wonder where the ALS g-force effects are located
m (→‎Post Flightgear 2017.1.1: corrected heading)
(Moving up the section with instructions for the new system; Adding link to additional source file, though I wonder where the ALS g-force effects are located)
Line 2: Line 2:


{{note|While the pilot will be temporarily blind due to g-force he will not be incapacitated (G-LOC) and will still be able to control the aircraft.}}
{{note|While the pilot will be temporarily blind due to g-force he will not be incapacitated (G-LOC) and will still be able to control the aircraft.}}
== Flightgear 2016.4.4 and earlier ==
=== Involved properties ===
Blackout and redout are controlled through these properties in <code>/sim/rendering/redout/</code>:
* <code>enabled</code> (bool)
* <code>parameters/blackout-onset-g</code> (double)
* <code>parameters/blackout-complete-g</code> (double)
* <code>parameters/redout-onset-g</code> (double)
* <code>parameters/redout-complete-g</code> (double)
These properties can be controlled at runtime or be added to any [[PropertyList XML files|PropertyList XML file]], for example an [[aircraft-set.xml]] or your own [[FlightGear configuration via XML|configuration file]].
In addition to these properties there is another property, <code>/sim/rendering/headshake/enabled</code> (bool), that will make the pilots viewpoint move up and down due to the g-force, for example due to maneuvers or turbulence.
=== Example ===
This example show how these setting can be added to a propertylist xml file:
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<PropertyList>
    <!-- ... -->
    <sim>
        <!-- ... -->
        <rendering>
            <redout>
                <enabled type="bool" userarchive="y">true</enabled>
                <parameters>
                    <blackout-onset-g>6</blackout-onset-g>
                    <blackout-complete-g>8</blackout-complete-g>
                    <redout-onset-g>-2</redout-onset-g>
                    <redout-complete-g>-4</redout-complete-g>
                </parameters>
            </redout>
            <headshake>
                <enabled type="bool" userarchive="y">true</enabled>
            </headshake>
        </rendering>
        <!-- ... -->
    </sim>
    <!-- ... -->
</PropertyList>
</syntaxhighlight>


== Flightgear 2017.1.1 and later ==
== Flightgear 2017.1.1 and later ==
Line 111: Line 67:
                     <recover-fast-sec type="double">7</recover-fast-sec>
                     <recover-fast-sec type="double">7</recover-fast-sec>
                     <recover-slow-sec type="double">15</recover-slow-sec>
                     <recover-slow-sec type="double">15</recover-slow-sec>
                </parameters>
            </redout>
            <headshake>
                <enabled type="bool" userarchive="y">true</enabled>
            </headshake>
        </rendering>
        <!-- ... -->
    </sim>
    <!-- ... -->
</PropertyList>
</syntaxhighlight>
== Flightgear 2016.4.4 and earlier ==
=== Involved properties ===
Blackout and redout are controlled through these properties in <code>/sim/rendering/redout/</code>:
* <code>enabled</code> (bool)
* <code>parameters/blackout-onset-g</code> (double)
* <code>parameters/blackout-complete-g</code> (double)
* <code>parameters/redout-onset-g</code> (double)
* <code>parameters/redout-complete-g</code> (double)
These properties can be controlled at runtime or be added to any [[PropertyList XML files|PropertyList XML file]], for example an [[aircraft-set.xml]] or your own [[FlightGear configuration via XML|configuration file]].
In addition to these properties there is another property, <code>/sim/rendering/headshake/enabled</code> (bool), that will make the pilots viewpoint move up and down due to the g-force, for example due to maneuvers or turbulence.
=== Example ===
This example show how these setting can be added to a propertylist xml file:
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<PropertyList>
    <!-- ... -->
    <sim>
        <!-- ... -->
        <rendering>
            <redout>
                <enabled type="bool" userarchive="y">true</enabled>
                <parameters>
                    <blackout-onset-g>6</blackout-onset-g>
                    <blackout-complete-g>8</blackout-complete-g>
                    <redout-onset-g>-2</redout-onset-g>
                    <redout-complete-g>-4</redout-complete-g>
                 </parameters>
                 </parameters>
             </redout>
             </redout>
Line 138: Line 138:


=== Source code ===
=== Source code ===
Used only by the new system
* {{fgdata file|Aircraft/Generic/g-forces.xml}}
Used by both new and old system
* {{fgdata file|Nasal/redout.nas}}
* {{fgdata file|Nasal/redout.nas}}
Used only by the old system
* {{flightgear file|src/Scenery/redout.hxx}}
* {{flightgear file|src/Scenery/redout.hxx}}
* {{flightgear file|src/Scenery/redout.cxx}}
* {{flightgear file|src/Scenery/redout.cxx}}

Navigation menu