Light¶
继承¶
VisualInstance
简要描述¶
提供不同种类的光节点的基类。
描述¶
Light是light节点的抽象基类，因此不应直接使用它（不能实例化）。其它的光节点类型继承于它。光包含常用变量和参数。
成员¶
| 类型 | 属性名 | 默认值 |
|---|---|---|
| bool | editor_only | false |
| int | light_bake_mode | 1 |
| Color | light_color | Color( 1, 1, 1, 1 ) |
| int | light_cull_mask | 4294967295 |
| float | light_energy | 1.0 |
| float | light_indirect_energy | 1.0 |
| bool | light_negative | false |
| float | light_specular | 0.5 |
| float | shadow_bias | 0.15 |
| Color | shadow_color | Color( 0, 0, 0, 1 ) |
| float | shadow_contact | 0.0 |
| bool | shadow_enabled | false |
| bool | shadow_reverse_cull_face | false |
方法¶
| 返回值类型 | 方法名称 |
|---|---|
| float | get_param(param: int) const |
| void | set_param(param: int, value: float) |
| ##枚举 | |
| enum Param: | |
| - PARAM_ENERGY = 0 |
用于访问light_energy的常数。
- PARAM_INDIRECT_ENERGY = 1
用于访问light_indirect_energy的常数。
- PARAM_SPECULAR = 2
用于访问light_specular的常数。
- PARAM_RANGE = 3
用于访问[成员OmniLight.omni_range]或[成员SpotLight.spot_range]的常数。
- PARAM_ATTENUATION = 4
用于访问[成员OmniLight.omni_衰减]或[成员SpotLight.spot_衰减]的常数。
- PARAM_SPOT_ANGLE = 5
用于访问[成员SpotLight.spot_angle]的常数。
- PARAM_SPOT_ATTENUATION = 6
用于访问[SpotLight.spot_angle_衰减成员]的常数。
- PARAM_CONTACT_SHADOW_SIZE = 7
用于访问shadow_contact的常数。
- PARAM_SHADOW_MAX_DISTANCE = 8
用于访问DirectionalLight.directional_shadow_max_distance的常数。
- PARAM_SHADOW_SPLIT_1_OFFSET = 9
用于访问[成员DirectionalLight.directional_shadow_split_1]的常数。
- PARAM_SHADOW_SPLIT_2_OFFSET = 10
用于访问DirectionalLight.directional_shadow_split_2的常数。
- PARAM_SHADOW_SPLIT_3_OFFSET = 11
用于访问DirectionalLight.directional_shadow_split_3的常数。
- PARAM_SHADOW_NORMAL_BIAS = 12
用于访问[成员DirectionalLight.directional_shadow_normal_bias]的常数。
- PARAM_SHADOW_BIAS = 13
用于访问shadow_bias的常数。
- PARAM_SHADOW_BIAS_SPLIT_SCALE = 14
用于访问DirectionalLight.directional_shadow_bias_split_scale的常数。
- PARAM_MAX = 15
表示Param枚举的大小。
enum BakeMode: - BAKE_DISABLED = 0
烘烤时忽略光。
**注意：**隐藏灯光不会*影响*烘烤。
- BAKE_INDIRECT = 1
仅间接照明将被烘焙（默认）。
- BAKE_ALL = 2
直接和间接光都将被烘烤。
**注意：**如果您不希望灯光出现两次（动态和烘焙），则应隐藏灯光。
常量¶
成员说明¶
- bool editor_only
| Default | false |
|---|---|
| setter | set_editor_only(value) |
| getter | is_editor_only |
- int light_bake_mode
| Default | 1 |
|---|---|
| setter | set_bake_mode(value) |
| getter | get_bake_mode |
- Color light_color
| Default | Color( 1, 1, 1, 1 ) |
|---|---|
| setter | set_color(value) |
| getter | get_color |
- int light_cull_mask
| Default | 4294967295 |
|---|---|
| setter | set_cull_mask(value) |
| getter | get_cull_mask |
- float light_energy
| Default | 1.0 |
|---|---|
| setter | set_param(value) |
| getter | get_param |
- float light_indirect_energy
| Default | 1.0 |
|---|---|
| setter | set_param(value) |
| getter | get_param |
- bool light_negative
| Default | false |
|---|---|
| setter | set_negative(value) |
| getter | is_negative |
- float light_specular
| Default | 0.5 |
|---|---|
| setter | set_param(value) |
| getter | get_param |
- float shadow_bias
| Default | 0.15 |
|---|---|
| setter | set_param(value) |
| getter | get_param |
- Color shadow_color
| Default | Color( 0, 0, 0, 1 ) |
|---|---|
| setter | set_shadow_color(value) |
| getter | get_shadow_color |
- float shadow_contact
| Default | 0.0 |
|---|---|
| setter | set_param(value) |
| getter | get_param |
- bool shadow_enabled
| Default | false |
|---|---|
| setter | set_shadow(value) |
| getter | has_shadow |
- bool shadow_reverse_cull_face
| Default | false |
|---|---|
| setter | set_shadow_reverse_cull_face(value) |
| getter | get_shadow_reverse_cull_face |
方法说明¶
- get_param get_param(param: int) const
返回指定的Light.Param参数的值。
- set_param set_param(param: int, value: float)
设置指定的Light.Param参数的值。