GetFogDistance: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
("Added" getFogDistance( ) function page)
Line 1: Line 1:
{{Server client function}}
__NOTOC__
__NOTOC__
{{Server client function}}
This function will tell you what is the current fog render distance.
 
{{Note|The function will return ''false'' server-side if fog distance has not been set before the function is called.}}
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float getFogDistance ()
float getFogDistance ( )
</syntaxhighlight>
</syntaxhighlight>
===Returns===
Returns a ''float'' with the current fog render distance, ''false'' if the operation could not be completed.


==Example==
==Example==
This example will demonstrate basic functionality of the function.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function fogDistance()
function fogDistance( )
outputChatBox("Your fog distance is: ".. getFogDistance())
outputChatBox( "Your fog distance is: " .. tostring( getFogDistance( ) ) )
end
end
addCommandHandler("fog", fogDistance)
addCommandHandler( "fog", fogDistance )
</syntaxhighlight>
</syntaxhighlight>
==See Also==
{{World_functions}}

Revision as of 13:12, 3 August 2014

This function will tell you what is the current fog render distance.

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

Syntax

float getFogDistance ( )

Returns

Returns a float with the current fog render distance, false if the operation could not be completed.

Example

This example will demonstrate basic functionality of the function. 

function fogDistance( )
	outputChatBox( "Your fog distance is: " .. tostring( getFogDistance( ) ) )
end
addCommandHandler( "fog", fogDistance )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetFogDistance?oldid=41146"