ToggleVehicleRespawn: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
==Description==
{{Server function}}
This function toggles whether or not the vehicle will be respawned after blown or idle.
This function toggles whether or not the vehicle will be respawned after blown or idle.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool toggleVehicleRespawn ( vehicle theVehicle, bool Respawn )</syntaxhighlight>
<syntaxhighlight lang="lua">bool toggleVehicleRespawn ( vehicle theVehicle, bool Respawn )</syntaxhighlight>
 
{{OOP||[[vehicle]]:toggleRespawn|respawnable|isVehicleRespawnable}}
===Required Arguments===
===Required Arguments===
*'''theVehicle''': The [[vehicle]] you wish to toggle the respawning of.
*'''theVehicle''': The [[vehicle]] you wish to toggle the respawning of.
Line 11: Line 11:


==Returns==
==Returns==
Returns 'true' if the vehicle was found and edited.
Returns ''true'' if the vehicle was found and edited.


==Example==
==Example==
This example defines a console command that will disable respawning for the vehicle that the player is currently in.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler ( "onPlayerConsole", root, "onPlayerConsole" )
function doNotRespawn ( thePlayer )
function onPlayerConsole ( text )
     local theVehicle = getPlayerOccupiedVehicle ( thePlayer )
  command = gettok ( text, 1, 32 )
     if ( theVehicle ) then
  if ( command == "doNotRespawn" ) then
        toggleVehicleRespawn ( theVehicle, false ) -- tell the server not to respawn this vehicle
     vehicle = getPlayerOccupiedVehicle ( source )
     if ( vehicle ) then
      toggleVehicleRespawn ( vehicle, false ) -- tell the server not to respawn this vehicle
     end
     end
  end
end
end
addCommandHandler("donotrespawn", doNotRespawn)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle_functions|server}}

Latest revision as of 23:05, 6 September 2024

This function toggles whether or not the vehicle will be respawned after blown or idle.

Syntax

bool toggleVehicleRespawn ( vehicle theVehicle, bool Respawn )

OOP Syntax Help! I don't understand this!

Method: vehicle:toggleRespawn(...)
Variable: .respawnable
Counterpart: isVehicleRespawnable


Required Arguments

  • theVehicle: The vehicle you wish to toggle the respawning of.
  • Respawn: A boolean determining if the vehicle will respawn or not.

Returns

Returns true if the vehicle was found and edited.

Example

This example defines a console command that will disable respawning for the vehicle that the player is currently in. 

function doNotRespawn ( thePlayer )
    local theVehicle = getPlayerOccupiedVehicle ( thePlayer )
    if ( theVehicle ) then
        toggleVehicleRespawn ( theVehicle, false ) -- tell the server not to respawn this vehicle
    end
end
addCommandHandler("donotrespawn", doNotRespawn)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/ToggleVehicleRespawn?oldid=80457"