Use epydoc for generating game python reference (like the bpython guys)
[blender.git] / source / gameengine / PyDoc / KX_Light.py
1 # $Id$
2 # Documentation for Light game objects.
3 from KX_GameObject import *
4
5 class KX_Light(KX_GameObject):
6         """
7         A Light object.
8
9         Example:
10         
11         # Turn on a red alert light.
12         import GameLogic
13         
14         co = GameLogic.getCurrentController()
15         light = co.getOwner()
16         
17         light.energy = 1.0
18         light.colour = [1.0, 0.0, 0.0]
19         
20         @group Constants: NORMAL, SPOT, SUN
21         @ivar SPOT:   A spot light source. See attribute 'type'
22         @ivar SUN:    A point light source with no attenuation. See attribute 'type'
23         @ivar NORMAL: A point light source. See attribute 'type'
24         
25         @ivar type:            The type of light - must be SPOT, SUN or NORMAL
26         @ivar layer:           The layer mask that this light affects object on. (bitfield)
27         @ivar energy:          The brightness of this light. (float)
28         @ivar distance:        The maximum distance this light can illuminate. (float) (SPOT and NORMAL lights only)
29         @ivar colour:          The colour of this light. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0]
30         @type colour:          list [r, g, b]
31         @ivar color:           Synonym for colour.
32         @ivar lin_attenuation: The linear component of this lights attenuation. (SPOT and NORMAL lights only)
33         @ivar spotsize:        The cone angle of the spot light, in degrees. (float) (SPOT lights only)
34                                0.0 <= spotsize <= 180.0. Spotsize = 360.0 is also accepted. 
35         @ivar spotblend:       Specifies the intensity distribution of the spot light. (float) (SPOT lights only)
36                                Higher values result in a more focused light source.
37                                0.0 <= spotblend <= 1.0.
38         
39         """