GetSunSize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server client function}} This function is used to get the size of the sun. ==Syntax== <syntaxhighlight lang="lua"> float getSunSize ( ) </syntaxhighlight> ===Returns=== Returns the size of t...")
 
No edit summary
 
Line 2: Line 2:
{{Server client function}}
{{Server client function}}
This function is used to get the size of the sun.
This function is used to get the size of the sun.
 
{{Note|The function will return ''false'' server-side if sun size has not been set before the function is called.}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">

Latest revision as of 17:04, 20 May 2020

This function is used to get the size of the sun.

[[{{{image}}}|link=|]] Note: The function will return false server-side if sun size has not been set before the function is called.

Syntax

float getSunSize ( )

Returns

Returns the size of the sun as a number, false if the size of the sun is at its default.

Example

This example lets any player get the size of the sun like /getsunsize

function commandGetSunSize(player, command)
    local size = getSunSize()
    if (size) then
        outputChatBox("The current size of the sun is "..size..".", player, 0, 255, 0)
    else
        outputChatBox("The size of the sun is normal.", player, 0, 255, 0)
    end
end
addCommandHandler("getsunsize", commandGetSunSize)

See Also