MTA:Eir/functions/engineIsWorldStreamingEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ This function returns whether the native GTA:SA world is allowed to stream and render. This property is meant to be used along with maps that are meant to exist stand-...")
 
mNo edit summary
Line 1: Line 1:
{{*Client_function}}
__NOTOC__  
__NOTOC__  
This function returns whether the native GTA:SA world is allowed to stream and render. This property is meant to be used along with maps that are meant to exist stand-alone (such as total conversion maps).
This function returns whether the native GTA:SA world is allowed to stream and render. This property is meant to be used along with maps that are meant to exist stand-alone (such as total conversion maps).

Revision as of 01:43, 12 January 2014

Template:*Client function

This function returns whether the native GTA:SA world is allowed to stream and render. This property is meant to be used along with maps that are meant to exist stand-alone (such as total conversion maps).

Syntax

bool engineIsWorldStreamingEnabled ()

Returns

Returns true if native world streaming is enabled, false otherwise.

Example

Click to collapse [-]
Client

This snippet plays a sound depending on whether world streaming is enabled or not. It expects two sound files: "win.wav" and "fail.wav"

addCommandHandler( "world_check",
    function()
        local isEnabled = engineIsWorldStreamingEnabled();

        if ( isEnabled ) then
            playSound( "win.wav" );
        else
            playSound( "fail.wav" );
        end
    end
);