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...")
 
mNo edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{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 0, are accepted. Using this function server-side will overwrite the value that was previously set client-side.
{{New feature/item|3.0132|1.3.1|5000|
This function sets the maximum velocity at which aircrafts could fly. Using this function server-side will overwrite the value that was previously set client-side.
}}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setAircraftMaxVelocity ( float fVelocity )
bool setAircraftMaxVelocity ( float velocity )
</syntaxhighlight>
</syntaxhighlight>
===Required Arguments===
*'''velocity:''' The max velocity, can be 0 or any positive value. Default is '''1.5'''.


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


==Examples==
==Example==
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
This example will increase or decrease the max velocity by pressing numpad keys + or -.
This example will increase or decrease the max velocity by pressing numpad keys + or -.
Line 24: Line 29:
             if setAircraftMaxVelocity( fMaxVelocity ) then
             if setAircraftMaxVelocity( fMaxVelocity ) then
                 outputChatBox( string.format( "Max velocity set to %.1f", fMaxVelocity ))
                 outputChatBox( string.format( "Max velocity set to %.1f", fMaxVelocity ))
            else
                outputChatBox( string.format( "Unable to set max velocity to %.1f", fMaxVelocity ) )
             end
             end


Line 44: Line 51:
This example will double the max velocity for everyone when the resource is started.
This example will double the max velocity for everyone when the resource is started.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function handleResourceStart( res )
function handleResourceStart( )
 
     setAircraftMaxVelocity( 3 )
     if res == resource then
        setAircraftMaxVelocity( 3 )
    end
end
end
addEventHandler( "onResourceStart",  root, handleResourceStart )</syntaxhighlight>
addEventHandler( "onResourceStart",  resourceRoot, handleResourceStart )</syntaxhighlight>
</section>
</section>


==See Also==
==See Also==
{{Client_world_functions}}
{{Client_world_functions}}

Latest revision as of 11:53, 22 April 2013

This function sets the maximum velocity at which aircrafts could fly. Using this function server-side will overwrite the value that was previously set client-side.

Syntax

bool setAircraftMaxVelocity ( float velocity )

Required Arguments

  • velocity: The max velocity, can be 0 or any positive value. Default is 1.5.

Returns

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

Example

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 ))
            else
                outputChatBox( string.format( "Unable to set max velocity 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( )
    setAircraftMaxVelocity( 3 )
end
addEventHandler( "onResourceStart",  resourceRoot, handleResourceStart )

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetAircraftMaxVelocity?oldid=35525"