Difference between revisions of "Con GetINISetting"
Jump to navigation
Jump to search
imported>WereWolf |
imported>Haama (Standardized function explanation) |
||
| Line 2: | Line 2: | ||
'''Syntax:''' | '''Syntax:''' | ||
con_GetINISetting " | con_GetINISetting "iniSettingName:Subsection::string" | ||
An alias for [[GetNumericINISetting]]. Returns the specified ini setting. | |||
iniSettingName is the name of the setting as it appears in the ini file. Subsection is the text in brackets that appears above the group to which the setting belongs. The quotes are required. | |||
==Example== | ==Example== | ||
| Line 19: | Line 19: | ||
*This function is identical to the GetINISetting [[:Category: Console Functions|Console Function]], and should behave as if you had called that function from the console. | *This function is identical to the GetINISetting [[:Category: Console Functions|Console Function]], and should behave as if you had called that function from the console. | ||
*This function was not designed to be run from scripts, and so may not work as expected. | *This function was not designed to be run from scripts, and so may not work as expected. | ||
==See Also== | |||
* [[GetNumericINISetting]] | |||
* [[SetNumericINISetting]] | |||
* [[GetGameSetting]] | |||
* [[SetNumericGameSetting]] | |||
* [[Con_SetGameSetting]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
Revision as of 08:48, 15 September 2007
A command for Oblivion Script Extender
Syntax:
con_GetINISetting "iniSettingName:Subsection::string"
An alias for GetNumericINISetting. Returns the specified ini setting. iniSettingName is the name of the setting as it appears in the ini file. Subsection is the text in brackets that appears above the group to which the setting belongs. The quotes are required.
Example
con_GetINISetting "bCrossHair:Gameplay"
Returns 0 or 1 based on whether the crosshair is enabled.
Notes
- This function can only handle settings whose name begins with 'b', 'i', or 'f', as Oblivion needs to know what type of variable it's returning and settings which do not begin with these letters could be of any variable type.
- Due to limitations of the Wiki software, the title of this article, and links to it, cannot display it correctly - there is an underscore (_) in the function's name.
- This function is identical to the GetINISetting Console Function, and should behave as if you had called that function from the console.
- This function was not designed to be run from scripts, and so may not work as expected.