Home > Working with SGWorld > Project (IProject6) > Settings

Settings

Allows defining the value of a specified parameter in the FLY file Project Settings. Each parameter is accessed by a unique identification string.

Note:    C# exposes this property as set_Settings and get_Settings methods.

 

JavaScript

 

Settings

 

C++

 

HRESULT Settings(

      [in] BSTR paramName,

      [out, retval] VARIANT* pVal)

HRESULT Settings(

      [in] BSTR paramName,

      [in] VARIANT pVal)

 

The following table describes the supported parameter string values and the respective parameter value options:

 

paramName

[In/Out] Type

pVal

Atmospheric Effects

"FogColor"

[in, out] long

The color of the fog that covers the terrain in hexadecimal form: 0x00bbggrr.

"SkyColor"

[in, out] long

The color of the sky in the hexadecimal form: 0x00bbggrr.

"VisualRange"

[in, out] double

Distance to the horizon, in meters

"FogStarting Distance"

[in, out] double

Distance, in meters, at which the fog starts

"UseSunAsLightSource"

[in, out] bool

No longer supported.

"DisplaySun"

[in, out] bool

A Boolean that determines whether  the sun is displayed.

"DisplaySunFlare"

[in, out] bool

No longer supported.

"SunAndMoonUseFixedLocalTime "

[in, out] bool

A Boolean that determines whether  the currently used date and time value is defined in local time (TRUE) or global date and time (FALSE).

"SunAndMoonFixedLocalTime "

[in, out] VT_DATE

Date (Javascript) or DateTime (C#) object that represents the currently used local time .

"SunAndMoonTime"

[in, out] VT_DATE

Date (Javascript) or DateTime (C#) object that represents the currently used global date and time .

"TimeZoneListXML"

[out] BSTR

An XML string that defines the available time zones in the operating system. For example:

<SELECT ID="TimeZoneList" SIZE="XX">

<OPTION VALUE ="Alaska Standart Time">(GMT-09:00) Alaska<OPTION>

. . .

<SELECT>

"SunAndMoonTimeZoneDisplayName"

[out] BSTR

A string description of the currently used time zone, e.g., "(GMT-09:00) Alaska". The string corresponds to the value of the OPTION node in the XML returned from "TimeZoneListXML”

"SunAndMoonTimeZoneKey"

[in, out] BSTR

A string key of the used time zone, e.g., "Alaska Standart Time". The key can be one of the VALUE attributes of an OPTION node in the XML returned from "TimeZoneListXML"

Flight Model

"MaxSpeed"

[in, out] long

Maximum speed in meters per second