Clairification on getBugOptionBOOL(

Admiral Armada

The Admiral of Armadas
Joined
Sep 11, 2004
Messages
462
Location
Terra
From what i can tell from looking at the code and how its used, the first argument is the id name, which needs to match the id in the options page you create in python, the second is the default value. But the third is a mystery. I cant find what it does. So what does it do?

Also, if there is an index of these functions somewhere then I was unable to find it.
 
bool getBugOptionBOOL(const char* id, bool bDefault, const char* xmlKey)
It's a "Global Define Name". getBugOptionBOOL first tries to get the value from python, and will succeed if BUG is there and the element present. If it fails, it first falls back to the value defined in GlobalDefinesAlt.xml; only if the specified Global Define doesn't exist it falls back to the second argument bDefault.
 
Precisely, and the first parameter is a combination of the ID of the <mod> element and the ID of the <option> element separated by a double-underscore.
 
Back
Top Bottom