SetSkySaturation: Difference between revisions
From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetSkySaturation(saturation)}} {{FuncParameters}} {{FuncParam|saturation|__EDIT_ME__}} {{FuncRetu...") |
No edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Info|Function|Client|1.0}} | {{Info|Function|Client|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Set the sky color saturation for the client.}} | ||
{{FuncSyntax|SetSkySaturation(saturation)}} | {{FuncSyntax|SetSkySaturation(saturation)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|saturation| | {{FuncParam|saturation|The saturation value in float between 0.0 to 4.0. Default: 1.05}} | ||
{{FuncReturnValue| | {{FuncReturnValue|Returns '''true'''.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua"> | |||
AddEvent("OnPlayerSpawn", function() | |||
SetSkySaturation(0.0) -- Set the saturation to as low as possible, basically monochrome. | |||
end) | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
*[[GetSkySaturation]] | |||
Latest revision as of 11:27, 1 September 2020
Description
Set the sky color saturation for the client.
Syntax
SetSkySaturation(saturation)
Parameters
- saturation
The saturation value in float between 0.0 to 4.0. Default: 1.05
Return Value
- Returns true.
Example
AddEvent("OnPlayerSpawn", function()
SetSkySaturation(0.0) -- Set the saturation to as low as possible, basically monochrome.
end)
