Difference between revisions of "Con GetINISetting"
Jump to navigation
Jump to search
imported>DragoonWraith (alphabetizing) |
imported>Scruggs |
||
| Line 2: | Line 2: | ||
'''Syntax:''' | '''Syntax:''' | ||
con_GetINISetting Setting | con_GetINISetting "Setting:Subsection" | ||
Reads the desired setting from Oblivion.ini while in game. | |||
Setting 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. | |||
==Example== | ==Example== | ||
con_GetINISetting | con_GetINISetting "bCrossHair:Gameplay" | ||
Returns the | Returns 0 or 1 based on whether the crosshair is enabled. | ||
==Notes== | ==Notes== | ||
| Line 17: | Line 18: | ||
*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. | ||
*Many INI settings can't be accessed using this function, including most of those in the Controls subsection. | |||
*Furthermore, many INI settings are not storable in any form of variable, and Oblivion's reaction to calling a function that returns such a value is unknown. | *Furthermore, many INI settings are not storable in any form of variable, and Oblivion's reaction to calling a function that returns such a value is unknown. | ||
[[Category: OBSE Functions|Getinisetting]] | [[Category: OBSE Functions|Getinisetting]] | ||
[[Category: OBSE Console Functions|Getinisetting]] | [[Category: OBSE Console Functions|Getinisetting]] | ||
Revision as of 07:53, 15 August 2006
A command for Oblivion Script Extender
Syntax:
con_GetINISetting "Setting:Subsection"
Reads the desired setting from Oblivion.ini while in game. Setting 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.
Example
con_GetINISetting "bCrossHair:Gameplay"
Returns 0 or 1 based on whether the crosshair is enabled.
Notes
- 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.
- Many INI settings can't be accessed using this function, including most of those in the Controls subsection.
- Furthermore, many INI settings are not storable in any form of variable, and Oblivion's reaction to calling a function that returns such a value is unknown.