d6cb23c9e6220f3158ec5a2a92679fc809dbf72d
[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 *********
22 Constants
23 *********
24
25    .. data:: KX_MIST_QUADRATIC
26
27       Type of quadratic attenuation used to fade mist.
28
29    .. data:: KX_MIST_LINEAR
30
31       Type of linear attenuation used to fade mist.
32
33    .. data:: KX_MIST_INV_QUADRATIC
34
35       Type of inverse quadratic attenuation used to fade mist.
36
37 **********
38 Attributes
39 **********
40
41    .. attribute:: mistEnable
42
43       Return the state of the mist.
44
45       :type: bool
46
47    .. attribute:: mistStart
48
49       The mist start point.
50
51       :type: float
52
53    .. attribute:: mistDistance
54
55       The mist distance fom the start point to reach 100% mist.
56
57       :type: float
58
59    .. attribute:: mistIntensity
60
61       The mist intensity.
62
63       :type: float
64
65    .. attribute:: mistType
66
67       The type of mist - must be KX_MIST_QUADRATIC, KX_MIST_LINEAR or KX_MIST_INV_QUADRATIC
68
69    .. attribute:: mistColor
70
71       The color of the mist. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0].
72       Mist and background color sould always set to the same color.
73
74       :type: :class:`mathutils.Vector`
75
76    .. attribute:: backgroundColor
77
78       The color of the background. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0].
79       Mist and background color sould always set to the same color.
80
81       :type: :class:`mathutils.Vector`
82
83    .. attribute:: ambientColor
84
85       The color of the ambient light. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0].
86
87       :type: :class:`mathutils.Vector`