Difference between revisions of "AttachVehicleNitro"

From Onset Developer Wiki
Line 1: Line 1:
 
{{Info|Function|Server|1.0}}
 
{{Info|Function|Server|1.0}}
  
{{FuncDescription|Enabled/Disables vehicle nitro function, value can be true or false}}
+
{{FuncDescription|Enables/Disables vehicle nitro function, value can be true or false}}
  
 
{{FuncSyntax|AttachVehicleNitro(vehicle [, attach])}}
 
{{FuncSyntax|AttachVehicleNitro(vehicle [, attach])}}
  
 
{{FuncParameters}}
 
{{FuncParameters}}
{{FuncParam|vehicle |Vehicle object which you want to attach nitro to}}
+
{{FuncParam|vehicle |Vehicle identifier which you want to attach nitro to.}}
{{FuncParamOptional|attach|boolean, an true or false value}}
+
{{FuncParamOptional|attach|boolean, a true or false value}}
  
{{FuncReturnValue|This function does not return any values}}
+
{{FuncReturnValue|This function does not return any value.}}
  
 
== Example ==
 
== Example ==

Revision as of 16:34, 12 August 2019

AttachVehicleNitro

Type: Function
Context: Server
Introduced: v1.0

Description

Enables/Disables vehicle nitro function, value can be true or false

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

__EDIT_ME__