Changeset View
Changeset View
Standalone View
Standalone View
doc/python_api/rst/bge_types/bge.types.KX_WorldInfo.rst
- This file was added.
| KX_WordlInfo(PyObjectPlus) | |||||
| ============================= | |||||
| .. module:: bge.types | |||||
| base class --- :class:`PyObjectPlus` | |||||
| .. class:: KX_WorldInfo(PyObjectPlus) | |||||
| A wolrd object. | |||||
| .. code-block:: python | |||||
| # Set the mist color to red. | |||||
| import bge | |||||
| sce = bge.logic.getCurrentScene() | |||||
moguri: bge.logic.getCurrentScene() does not return a list, so leave off the indexing. | |||||
| sce.world.mist_color = [1.0, 0.0, 0.0] | |||||
Not Done Inline ActionsShouldn't this be sce.world.mist_color? moguri: Shouldn't this be sce.world.mist_color? | |||||
Not Done Inline ActionsYes, should be sce.world.mist_color. hg1: Yes, should be sce.world.mist_color. | |||||
| ********* | |||||
| Constants | |||||
| ********* | |||||
| .. data:: KX_MIST_QUADRATIC | |||||
| Type of quadratic attenuation used to fade mist. | |||||
| .. data:: KX_MIST_LINEAR | |||||
| Type of linear attenuation used to fade mist. | |||||
| .. data:: KX_MIST_INV_QUADRATIC | |||||
| Type of inverse quadratic attenuation used to fade mist. | |||||
| ********** | |||||
| Attributes | |||||
| ********** | |||||
| .. attribute:: mist_enable | |||||
| Return the state of the mist. | |||||
| :type: bool | |||||
| .. attribute:: mist_start | |||||
| The mist start point. | |||||
| :type: float | |||||
| .. attribute:: mist_distance | |||||
| The mist distance fom the start point to reach 100% mist. | |||||
| :type: float | |||||
| .. attribute:: mist_intensity | |||||
| The mist intensity. | |||||
| :type: float | |||||
| .. attribute:: mist_type | |||||
| The type of mist - must be KX_MIST_QUADRATIC, KX_MIST_LINEAR or KX_MIST_INV_QUADRATIC | |||||
| .. attribute:: mist_color | |||||
| The color of the mist. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0]. | |||||
| Mist and background color sould always set to the same color. | |||||
| :type: :class:`mathutils.Vector` | |||||
| .. attribute:: background_color | |||||
| The color of the background. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0]. | |||||
| Mist and background color sould always set to the same color. | |||||
| :type: :class:`mathutils.Vector` | |||||
| .. attribute:: ambient_color | |||||
| The color of the ambient light. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0]. | |||||
| :type: :class:`mathutils.Vector` | |||||
bge.logic.getCurrentScene() does not return a list, so leave off the indexing.