SetCloudsEnabled: Difference between revisions

Latest revision as of 23:16, 11 January 2023

This function will enable or disable clouds. This is useful for race maps which are placed high up as clouds can cause low FPS.

bool setCloudsEnabled ( bool enabled )

enabled: A boolean value determining if clouds should be shown. Use true to show clouds and false to hide them.

Returns true if the cloud state was changed succesfully, false if an invalid argument was specified.

Click to collapse [-]

Server

This example disables clouds for all players when resource starts.

function onResourceStart()
    setCloudsEnabled(false)
end
addEventHandler("onResourceStart", resourceRoot, onResourceStart)

@@ Line 16: / Line 16: @@
 ==Example==
 <section name="Server" class="server" show="true">
-This example Disables clouds for all players
+This example disables clouds for all players when resource starts.
 <syntaxhighlight lang="lua">
-function disableClouds ()
+function onResourceStart()
-     setCloudsEnabled ( false )    -- Hide the clouds for all players when the resource starts
+     setCloudsEnabled(false)
 end
-addEventHandler ( "onResourceStart", getResourceRootElement(), disableClouds )
+addEventHandler("onResourceStart", resourceRoot, onResourceStart)
 </syntaxhighlight>
 </section>