Options.config - Revision history

Timo 6: Update categories

2012-09-01T10:32:07Z

Update categories

Timo 6: 4 revisions: Import from old wiki (on 15 May 2012)

2012-08-26T17:25:16Z

4 revisions: Import from old wiki (on 15 May 2012)

Timo 6 at 11:34, 11 December 2010

2010-12-11T11:34:49Z

New page

VDrift has a set of options which can be added to menus, referenced by the game, and used as a template for a player's settings. These options are defined in '''data/settings/options.config''' in the [[Configfile format]] that VDrift uses for many of its other text files. Once defined, these options can be referred to by the menus to do several things, including: pick default values for options, to get names, descriptions, and lists of values for options, check the type of options, and much more.

{{note|The options.config file is '''not''' the place where the user's settings are stored. Users should never need to edit this file. User options are set in [[VDrift.config]].}}

The options tell what values are available to the user for a given setting. This may seem confusing. Here's an example definition of an option in the file:
[ option-17 ]
cat = display
name = view_distance
title = View Distance
desc = Change the maximum view distance.
type = float
default = 500.0
values = list
num_vals = 5
opt00 = Very Low (0.25 km)
val00 = 250.0
opt01 = Low (0.5 km)
val01 = 500.0
opt02 = Medium (1 km)
val02 = 1000.0
opt03 = High (2.5 km)
val03 = 2500.0
opt04 = Very High (10 km)
val04 = 10000.0
The first line has the option ID number. This must be in the format <code>[ option-## ]</code> and number must be less than num_options. No two widgets should have the same ID. The first field, <code>cat</code>, is just for categorization. This option is in the display category. Next comes the option's name, which combined with the category, makes up the name by which the option is referred to in the menu (here, "display.view_distance"). The <code>title</code> field tells the human-readable name for this option. <code>desc</code> tells a little more about the option, this usually goes in the tip for the option in the menu. <code>type</code> is very important because it tells the game how to interpret the values given to it for each option. This particular option is a floating point option, which means it has a decimal, so it is <code>type</code> float. <code>default</code> is, as you probably guessed, the default value for the option.

The <code>values</code> needs a little extra explanation. In this case it is "list" which means that the possible values for the option will be listed along with this option definition. Sometimes <code>values</code> is given an alternate value which tells the game to get the list of values from some other special place. Since this option needs a list of values, we define the list: <code>num_vals</code> tells how many possible options there are; and the following <code>opt-##</code> and <code>val-##</code> fields describe the displayed name for the value, and the actual value, respectively. The <code>opt-##</code> fields are assumed to be strings, but the <code>val-##</code> fields must be of the same type as the type of the object, as must the <code>default</code> setting described earlier. Putting the wrong type of values here can cause very unexpected results.

[[Category:Files]]
[[Category:Expand]]

← Older revision		Revision as of 10:32, 1 September 2012
Line 26:		Line 26:

	The <code>values</code> needs a little extra explanation. In this case it is "list" which means that the possible values for the option will be listed along with this option definition. Sometimes <code>values</code> is given an alternate value which tells the game to get the list of values from some other special place. Since this option needs a list of values, we define the list: <code>num_vals</code> tells how many possible options there are; and the following <code>opt-##</code> and <code>val-##</code> fields describe the displayed name for the value, and the actual value, respectively. The <code>opt-##</code> fields are assumed to be strings, but the <code>val-##</code> fields must be of the same type as the type of the object, as must the <code>default</code> setting described earlier. Putting the wrong type of values here can cause very unexpected results.		The <code>values</code> needs a little extra explanation. In this case it is "list" which means that the possible values for the option will be listed along with this option definition. Sometimes <code>values</code> is given an alternate value which tells the game to get the list of values from some other special place. Since this option needs a list of values, we define the list: <code>num_vals</code> tells how many possible options there are; and the following <code>opt-##</code> and <code>val-##</code> fields describe the displayed name for the value, and the actual value, respectively. The <code>opt-##</code> fields are assumed to be strings, but the <code>val-##</code> fields must be of the same type as the type of the object, as must the <code>default</code> setting described earlier. Putting the wrong type of values here can cause very unexpected results.
−

	[[Category:Files]]		[[Category:Files]]
−	~~[[Category:Expand]]~~

← Older revision	Revision as of 17:25, 26 August 2012
(No difference)