GetFogDistance: Difference between revisions

Latest revision as of 13:13, 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.

float getFogDistance ( )

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

This example will demonstrate basic functionality of the function.

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

@@ Line 1: / Line 1: @@
+{{Server client function}}
 __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==
 <syntaxhighlight lang="lua">
-float getFogDistance ()
+float getFogDistance ( )
 </syntaxhighlight>
+===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.
 <syntaxhighlight lang="lua">
-function fogDistance()
+function fogDistance( )
-	outputChatBox("Your fog distance is: ".. getFogDistance())
+	outputChatBox( "Fog distance is: " .. tostring( getFogDistance( ) ) )
 end
-addCommandHandler("fog", fogDistance)
+addCommandHandler( "fog", fogDistance )
 </syntaxhighlight>
+==See Also==
+{{World_functions}}