World

* Class containing world settings used in a scene.

Members

Functions

getExpHeightFogColor
Vector3F getExpHeightFogColor()

* Returns the exponential height fog color.

getKillZ
float getKillZ()

* Returns the kill-z value.

setDefaultExpHeightFogColor
typeof(this) setDefaultExpHeightFogColor()

* Set exp height fog color to default value WORLD_DEFAULT_EXP_HEIGHT_FOG_COLOR. * Returns reference to this so it can be used in a stream.

setDefaultKillZ
typeof(this) setDefaultKillZ()

* Set kill-z to default value WORLD_DEFUALT_KILL_Z. * Returns reference to this so it can be used in a stream.

setExpHeightFogColor
typeof(this) setExpHeightFogColor(float r, float g, float b)

* Set the exp height fog color of the scene using 3 floats for the color (RGB) in a template stream function. * Assign a value to exp height fog color using world.setExpHeightFogColor(r, g, b) or world.setExpHeightFogColor!"="(r, g, b). * Increment exp height fog color by value using world.setExpHeightFogColor!"+="(r, g, b). * Decrement exp height fog color by value using world.setExpHeightFogColor!"-="(r, g, b). * Multiply exp height fog color by value using world.setExpHeightFogColor!"*="(r, g, b). * Divide exp height fog color by value using world.setExpHeightFogColor!"/="(r, g, b). * Returns reference to this so it can be used in a stream.

setExpHeightFogColor
typeof(this) setExpHeightFogColor(Vector3F expHeightFogColor)

* Set the exp height fog color of the scene using a vector of 3 values for the color (RGB) in a template stream function. * Assign a value to exp height fog color using world.setExpHeightFogColor(vector3) or world.setExpHeightFogColor!"="(vector3). * Increment exp height fog color by value using world.setExpHeightFogColor!"+="(vector3). * Decrement exp height fog color by value using world.setExpHeightFogColor!"-="(vector3). * Multiply exp height fog color by value using world.setExpHeightFogColor!"*="(vector3). * Divide exp height fog color by value using world.setExpHeightFogColor!"/="(vector3). * Returns reference to this so it can be used in a stream.

setKillZ
typeof(this) setKillZ(float value)

* Set the kill-z of the scene using a value in a template stream function. * Assign a value to kill-z using world.setKillZ(value) or world.setKillZ!"="(value). * Increment kill-z by value using world.setKillZ!"+="(value). * Decrement kill-z by value using world.setKillZ!"-="(value). * Multiply kill-z by value using world.setKillZ!"*="(value). * Divide kill-z by value using world.setKillZ!"/="(value). * Returns reference to this so it can be used in a stream.

setNoKillZ
typeof(this) setNoKillZ()

* Disable kill-z using value WORLD_NO_KILL_Z. * Returns reference to this so it can be used in a stream.

Meta