AttachVehicleNitro: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|AttachVehicleNitro(vehicle [, attach])}} {{FuncParameters}} {{FuncParam|vehicle |__EDIT_ME__}} {{F..."
 
28days (talk | contribs)
833 edits
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Enables/Disables vehicle nitro function.}}


{{FuncSyntax|AttachVehicleNitro(vehicle [, attach])}}
{{FuncSyntax|AttachVehicleNitro(vehicle [, attach])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|vehicle |__EDIT_ME__}}
{{FuncParam|vehicle |Vehicle identifier which you want to attach nitro to.}}
{{FuncParamOptional|attach|__EDIT_ME__}}
{{FuncParamOptional|attach|boolean, a true or false value}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function does not return any value.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
function ToggleNitro(player)
--Gets vehicle player is currently driving
local vehicle = GetPlayerVehicle(player)
--make sure vehicle is not equal to 0
if vehicle ~= 0 then
--enable nitro + print a message on the chat
AttachVehicleNitro(vehicle, true)
AddPlayerChat(player, "Nitro has been enabled")
else
--vehicle was equal to 0 and vehicle was not found, print an error message on the chat
AddPlayerChat(player, "You must be in a vehicle to enable nitro")
end
end
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{VehicleFunctions}}

Latest revision as of 17:12, 13 December 2019

AttachVehicleNitro

Type: Function
Context: Server
Introduced: v1.0

Description

Enables/Disables vehicle nitro function.

Syntax

AttachVehicleNitro(vehicle [, attach])

Parameters

  • vehicle
    Vehicle identifier which you want to attach nitro to.
  • attach (optional)
    boolean, a true or false value

Return Value

  • This function does not return any value.

Example

function ToggleNitro(player)
	--Gets vehicle player is currently driving
	local vehicle = GetPlayerVehicle(player)
	
	--make sure vehicle is not equal to 0
	if vehicle ~= 0 then
		--enable nitro + print a message on the chat
		AttachVehicleNitro(vehicle, true)
		
		AddPlayerChat(player, "Nitro has been enabled")
	else
		--vehicle was equal to 0 and vehicle was not found, print an error message on the chat
		AddPlayerChat(player, "You must be in a vehicle to enable nitro")
	end
	
end

See also

Retrieved from "https://dev.playonset.com/index.php?title=AttachVehicleNitro&oldid=3194"