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