Pydoc: Fix multiple bpy.type modules
[blender.git] / doc / python_api / rst / bge_types / bge.types.KX_LightObject.rst
1 KX_LightObject(KX_GameObject)
2 =============================
3
4 base class --- :class:`KX_GameObject`
5
6 .. class:: KX_LightObject(KX_GameObject)
7
8    A Light object.
9
10    .. code-block:: python
11
12       # Turn on a red alert light.
13       import bge
14
15       co = bge.logic.getCurrentController()
16       light = co.owner
17
18       light.energy = 1.0
19       light.color = [1.0, 0.0, 0.0]
20
21    .. data:: SPOT
22
23       A spot light source. See attribute :data:`type`
24
25    .. data:: SUN
26
27       A point light source with no attenuation. See attribute :data:`type`
28
29    .. data:: NORMAL
30
31       A point light source. See attribute :data:`type`
32
33    .. attribute:: type
34
35       The type of light - must be SPOT, SUN or NORMAL
36
37    .. attribute:: layer
38
39       The layer mask that this light affects object on.
40
41       :type: bitfield
42
43    .. attribute:: energy
44
45       The brightness of this light.
46
47       :type: float
48
49    .. attribute:: shadowClipStart
50
51       The shadowmap clip start, below which objects will not generate shadows.
52
53       :type: float (read only)
54
55    .. attribute:: shadowClipEnd
56
57       The shadowmap clip end, beyond which objects will not generate shadows.
58
59       :type: float (read only)
60
61    .. attribute:: shadowFrustumSize
62
63       Size of the frustum used for creating the shadowmap.
64
65       :type: float (read only)
66
67    .. attribute:: shadowBindId
68
69       The OpenGL shadow texture bind number/id.
70
71       :type: int (read only)
72
73    .. attribute:: shadowMapType
74
75       The shadow shadow map type (0 -> Simple; 1 -> Variance)
76
77       :type: int (read only)
78
79    .. attribute:: shadowBias
80
81       The shadow buffer sampling bias.
82
83       :type: float (read only)
84
85    .. attribute:: shadowBleedBias
86
87       The bias for reducing light-bleed on variance shadow maps.
88
89       :type: float (read only)
90
91    .. attribute:: useShadow
92
93       Returns True if the light has Shadow option activated, else returns False.
94
95       :type: boolean (read only)
96
97    .. attribute:: shadowColor
98
99       The color of this light shadows. Black = (0.0, 0.0, 0.0), White = (1.0, 1.0, 1.0).
100
101       :type: :class:`mathutils.Color` (read only)
102
103    .. attribute:: shadowMatrix
104
105       Matrix that converts a vector in camera space to shadow buffer depth space.
106
107       Computed as:
108           mat4_perspective_to_depth * mat4_lamp_to_perspective * mat4_world_to_lamp * mat4_cam_to_world.
109
110       mat4_perspective_to_depth is a fixed matrix defined as follow:
111
112          0.5 0.0 0.0 0.5
113          0.0 0.5 0.0 0.5
114          0.0 0.0 0.5 0.5
115          0.0 0.0 0.0 1.0
116
117       .. note:
118
119          There is one matrix of that type per lamp casting shadow in the scene.
120
121       :type: Matrix4x4 (read only)
122
123    .. attribute:: distance
124
125       The maximum distance this light can illuminate. (SPOT and NORMAL lights only).
126
127       :type: float
128
129    .. attribute:: color
130
131       The color of this light. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0].
132
133       :type: list [r, g, b]
134
135    .. attribute:: lin_attenuation
136
137       The linear component of this light's attenuation. (SPOT and NORMAL lights only).
138
139       :type: float
140
141    .. attribute:: quad_attenuation
142
143       The quadratic component of this light's attenuation (SPOT and NORMAL lights only).
144
145       :type: float
146
147    .. attribute:: spotsize
148
149       The cone angle of the spot light, in degrees (SPOT lights only).
150
151       :type: float in [0 - 180].
152
153    .. attribute:: spotblend
154
155       Specifies the intensity distribution of the spot light (SPOT lights only).
156
157       :type: float in [0 - 1]
158
159       .. note::
160          
161          Higher values result in a more focused light source.