BGE: Remove chapter in KX_WorldInfo python API
[blender.git] / doc / python_api / rst / bge_types / bge.types.KX_WorldInfo.rst
1 KX_WordlInfo(PyObjectPlus)
2 =============================
3
4 .. module:: bge.types
5
6 base class --- :class:`PyObjectPlus`
7
8 .. class:: KX_WorldInfo(PyObjectPlus)
9
10    A wolrd object.
11
12    .. code-block:: python
13
14       # Set the mist color to red.
15       import bge
16
17       sce = bge.logic.getCurrentScene()
18
19       sce.world.mistColor = [1.0, 0.0, 0.0]
20
21    .. data:: KX_MIST_QUADRATIC
22
23       Type of quadratic attenuation used to fade mist.
24
25    .. data:: KX_MIST_LINEAR
26
27       Type of linear attenuation used to fade mist.
28
29    .. data:: KX_MIST_INV_QUADRATIC
30
31       Type of inverse quadratic attenuation used to fade mist.
32
33    .. attribute:: mistEnable
34
35       Return the state of the mist.
36
37       :type: bool
38
39    .. attribute:: mistStart
40
41       The mist start point.
42
43       :type: float
44
45    .. attribute:: mistDistance
46
47       The mist distance fom the start point to reach 100% mist.
48
49       :type: float
50
51    .. attribute:: mistIntensity
52
53       The mist intensity.
54
55       :type: float
56
57    .. attribute:: mistType
58
59       The type of mist - must be KX_MIST_QUADRATIC, KX_MIST_LINEAR or KX_MIST_INV_QUADRATIC
60
61    .. attribute:: mistColor
62
63       The color of the mist. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0].
64       Mist and background color sould always set to the same color.
65
66       :type: :class:`mathutils.Vector`
67
68    .. attribute:: backgroundColor
69
70       The color of the background. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0].
71       Mist and background color sould always set to the same color.
72
73       :type: :class:`mathutils.Vector`
74
75    .. attribute:: ambientColor
76
77       The color of the ambient light. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0].
78
79       :type: :class:`mathutils.Vector`