SetSunRadius: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetSunRadius(radius)}} {{FuncParameters}} {{FuncParam|radius|__EDIT_ME__}} {{FuncReturnValue|__ED...")
 
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|__EDIT_ME__}}
{{FuncDescription|Set the specified radius of the sun for the client.}}


{{FuncSyntax|SetSunRadius(radius)}}
{{FuncSyntax|SetSunRadius(radius)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|radius|__EDIT_ME__}}
{{FuncParam|radius|A float value between 0.0 and 10.0, default: 0.5357}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true'''.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
AddEvent("OnPlayerSpawn", function()
SetSunRadius(0.5357)
end)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
* [[GetSunRadius]]

Latest revision as of 09:34, 1 September 2020

SetSunRadius

Type: Function
Context: Client
Introduced: v1.0

Description

Set the specified radius of the sun for the client.

Syntax

SetSunRadius(radius)

Parameters

  • radius
    A float value between 0.0 and 10.0, default: 0.5357

Return Value

  • Returns true.

Example

AddEvent("OnPlayerSpawn", function()
	SetSunRadius(0.5357)
end)

See also