CreateVehicle: Difference between revisions

From Onset Developer Wiki
← Older edit
No edit summary
No edit summary
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


== Syntax ==
{{FuncDescription|This function creates a vehicle at a desired location.
<syntaxhighlight lang="Lua">
'''Vehicles automatically respawn after 5 minutes. Use [[SetVehicleRespawnParams]] to control this behavior.'''}}
CreateVehicle(modelid, x, y, z [, heading])
 
</syntaxhighlight>
{{FuncSyntax|CreateVehicle(modelid, x, y, z [, heading])}}
==== Parameters ====
<div class="noprint" style="float:right;">
[[File:vehicle_spawn.gif]]
</div>
{{FuncParameters}}
{{FuncParam|modelid|The [[Vehicles|model identifier]] for which vehicle to spawn.}}
{{FuncParam|modelid|The [[Vehicles|model identifier]] for which vehicle to spawn.}}
{{FuncParam|x, y, z|The location/coordinates of where this vehicle is going to spawn.}}
{{FuncParam|x, y, z|The location/coordinates of where this vehicle is going to spawn.}}
{{FuncParam|heading|The direction in which this vehicle is going to be positioned.}}
{{FuncParamOptional|heading|The direction (yaw axis) in which this vehicle is going to be positioned.}}


==== Return Value ====
{{FuncReturnValue|Returns an identifier to the new vehicle. '''false''' on error.}}
* Returns an identifier to the new vehicle. '''false''' on error.


== Example ==
== Example ==
Line 21: Line 23:


model = tonumber(model)
model = tonumber(model)
if (model < 1 or model > 12) then
return AddPlayerChat(player, "Vehicle model "..model.." does not exist.")
end


local x, y, z = GetPlayerLocation(player)
local x, y, z = GetPlayerLocation(player)
Line 34: Line 32:
end
end


SetVehicleLicensePlate(vehicle, "HORIZON")
SetVehicleLicensePlate(vehicle, "ONSET")
AttachVehicleNitro(vehicle, true)
AttachVehicleNitro(vehicle, true)


Line 50: Line 48:
AddCommand("v", cmd_v)
AddCommand("v", cmd_v)
</syntaxhighlight>
</syntaxhighlight>
{{RelatedFunctions}}
{{VehicleFunctions}}

Latest revision as of 10:58, 4 November 2020

CreateVehicle

Type: Function
Context: Server
Introduced: v1.0

Description

This function creates a vehicle at a desired location. Vehicles automatically respawn after 5 minutes. Use SetVehicleRespawnParams to control this behavior.

Syntax

CreateVehicle(modelid, x, y, z [, heading])

Parameters

  • modelid
    The model identifier for which vehicle to spawn.
  • x, y, z
    The location/coordinates of where this vehicle is going to spawn.
  • heading (optional)
    The direction (yaw axis) in which this vehicle is going to be positioned.

Return Value

  • Returns an identifier to the new vehicle. false on error.

Example

function cmd_v(player, model)
	if (model == nil) then
		return AddPlayerChat(player, "Usage: /v <model>")
	end

	model = tonumber(model)

	local x, y, z = GetPlayerLocation(player)
	local h = GetPlayerHeading(player)

	local vehicle = CreateVehicle(model, x, y, z, h)
	if (vehicle == false) then
		return AddPlayerChat(player, "Failed to spawn your vehicle")
	end

	SetVehicleLicensePlate(vehicle, "ONSET")
	AttachVehicleNitro(vehicle, true)

	if (model == 8) then
		-- Set Ambulance blue color and license plate text
		SetVehicleColor(vehicle, RGB(0.0, 60.0, 240.0))
		SetVehicleLicensePlate(vehicle, "EMS-02")
	end

    -- Set us in the driver seat
	SetPlayerInVehicle(player, vehicle)

	AddPlayerChat(player, "Vehicle spawned! (New ID: "..vehicle..")")
end
AddCommand("v", cmd_v)

See also

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