SetAircraftMaxVelocity: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server client function}} This function sets the maximum velocity at which aircrafts could fly. Default value is 1.5 (around 276 km/h). Only positive values, including...")
 
Line 9: Line 9:


===Returns===
===Returns===
Returns true if the velocity was set correctly, false otherwise.
Returns true if the max velocity was set correctly, false otherwise.


==Examples==
==Examples==

Revision as of 04:46, 8 February 2013

This function sets the maximum velocity at which aircrafts could fly. Default value is 1.5 (around 276 km/h). Only positive values, including 0, are accepted. Using this function server-side will overwrite the value that was previously set client-side.

Syntax

bool setAircraftMaxVelocity ( float fVelocity )

Returns

Returns true if the max velocity was set correctly, false otherwise.

Examples

Click to collapse [-]
Client

This example will increase or decrease the max velocity by pressing numpad keys + or -.

function handleKeyboard( key, state )

    if state then

        if key == "num_add" then

            local fMaxVelocity = getAircraftMaxVelocity() + 0.1

            if setAircraftMaxVelocity( fMaxVelocity ) then
                outputChatBox( string.format( "Max velocity set to %.1f", fMaxVelocity ))
            end

        elseif key == "num_sub" then

            local fMaxVelocity = getAircraftMaxVelocity() - 0.1

            if setAircraftMaxVelocity( fMaxVelocity ) then
                outputChatBox( string.format( "Max velocity set to %.1f", fMaxVelocity ) )
            else
                outputChatBox( string.format( "Unable to set max velocity to %.1f", fMaxVelocity ) )
            end
        end
    end
end

addEventHandler( "onClientKey", root, handleKeyboard )
Click to collapse [-]
Server

This example will double the max velocity for everyone when the resource is started.

function handleResourceStart( res )

    if res == resource then
        setAircraftMaxVelocity( 3 )
    end
end
addEventHandler( "onResourceStart",  root, handleResourceStart )

See Also