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