ResetFarClipDistance: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server client function}} ==Syntax== <syntaxhighlight lang="lua"> bool resetFarClipDistance() </syntaxhighlight>")
 
m (Updated note)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Server client function}}
__NOTOC__
__NOTOC__
{{Server client function}}
This function resets the far clip distance to its default state.
{{Note|The function will not reset far clip distance client-side, unless it is relying on a value set by the server.}}
{{Note|The function will reset the far clip distance to ''false'' server-side, as there is no default value to begin with.}}
==Syntax==
<syntaxhighlight lang="lua">
bool resetFarClipDistance ( )
</syntaxhighlight>
 
===Returns===
Returns ''true'' if operation was successful, ''false'' otherwise.


==Syntax==
==Example==  
This example will demonstrate basic functionality of the function.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool resetFarClipDistance()
setFarClipDistance( 1200 )
outputDebugString( "Render distance: " .. getFarClipDistance( ) )
resetFarClipDistance( )
outputDebugString( "New render distance: " .. tostring( getFarClipDistance( ) ) )
</syntaxhighlight>
</syntaxhighlight>
==See Also==
{{World_functions}}

Latest revision as of 13:14, 3 August 2014

This function resets the far clip distance to its default state.

[[{{{image}}}|link=|]] Note: The function will not reset far clip distance client-side, unless it is relying on a value set by the server.
[[{{{image}}}|link=|]] Note: The function will reset the far clip distance to false server-side, as there is no default value to begin with.

Syntax

bool resetFarClipDistance ( )

Returns

Returns true if operation was successful, false otherwise.

Example

This example will demonstrate basic functionality of the function.

setFarClipDistance( 1200 )
outputDebugString( "Render distance: " .. getFarClipDistance( ) )
resetFarClipDistance( )
outputDebugString( "New render distance: " .. tostring( getFarClipDistance( ) ) )

See Also