formatting and updating cvars part 3

This commit is contained in:
Helldembez 2022-08-28 16:36:31 +02:00 committed by Aciz
parent 73d36e3f5a
commit 8341d349d5
4 changed files with 1352 additions and 1089 deletions

View file

@ -0,0 +1,3 @@
.wy-table-responsive table td {
white-space: normal;
}

View file

@ -24,7 +24,6 @@ author = 'ET: Legacy Team'
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = '2.76' release = '2.76'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# The master toctree document. # The master toctree document.
@ -46,7 +45,6 @@ templates_path = ['_templates']
# This pattern also affects html_static_path and html_extra_path. # This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
@ -67,4 +65,8 @@ pygments_style = 'sphinx'
# -- Options for todo extension ---------------------------------------------- # -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing. # If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True todo_include_todos = True
def setup(app):
app.add_css_file('custom-styles.css')

2382
cvars.rst

File diff suppressed because it is too large Load diff

View file

@ -2,6 +2,54 @@
Resources Resources
========= =========
.. _cvar-types:
CVAR Types
^^^^^^^^^^
Bitflag
-------
Bit Flags are used to store more than one `boolean value <Boolean>`_ in one number. To achieve this the value is read as a binary number.
A binary number is represented in the following way:
Normal: 128 64 32 16 8 4 2 1
Binary 0 0 0 0 0 0 0 0
A binary number of '11111111' would mean 255. As all the boolean values are true for their respective value.
So if you take the number 7 represented in binary it would look like this: '111'. This is because it adds 1 + 2 + 4 = 7.
This representation is used to enable or disable selectively multiple features through a single number.
List
----
A simple list of values, usually numbers that follow each other like '1,2,3'.
Range
-----
A range value is a value that can be between two numbers. For example 1 until 100. Depending on the CVAR this can be positive, negative or both positive and negative. See the following example:
1 until 3 - Available values: '1, 2, 3'.
-3 until -1 - Available values: '-3, -2, -1'.
-1 until 1 - Available values: '-1, 0, 1'.
The CVAR value can be a decimal or a integer.
Decimal: 1.0
Integer: 1
Boolean
-------
A value represented in '0' and '1'. Usually '1' means On/Enabled where '0' is Off/Disabled.
String
------
A text value.
Colors Colors
^^^^^^ ^^^^^^