GetVehicleIDFromName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Added shared name note)
Line 13: Line 13:
===Returns===
===Returns===
Returns an [[int]] if the name exists, ''false'' otherwise.
Returns an [[int]] if the name exists, ''false'' otherwise.
If you use this function on vehicles with shared names, such as "police", it will return the earliest occurrence of that vehicle's ID.


==Example==  
==Example==  

Revision as of 23:39, 18 March 2008

This function retrieves the ID of a vehicle as an integer value from its name.

Syntax

int getVehicleIDFromName ( string name )

Required Arguments

  • name: A string containing the name of the vehicle.

Returns

Returns an int if the name exists, false otherwise. If you use this function on vehicles with shared names, such as "police", it will return the earliest occurrence of that vehicle's ID.

Example

This will allow the player to create a vehicle by name and it's ID will be displayed in the chatbox when the vehicle is spawned. 

function createvehiclecommand ( sourcePlayer, commandName, carname )
	-- This function is triggered by the text "spawnvehicle" in the console.
	-- The player must specify the added parameter 'carname' to specify
	-- what car they wish to spawn.
	local carid = getVehicleIDFromName ( carname )
	-- Get the ID of the car the player asked for and store it to the
	-- variable 'carid'
	local x, y, z = getElementPosition ( sourcePlayer )
	-- Get the position of the player to spawn the car near this location
	if carid == false then
		outputChatBox ( "That is not a valid car name" )
	else
		createVehicle ( carid, x + 5, y, z )
		-- Spawn the car using its ID. Spawn it at x + 5 from the player so it doesn't crush him
		outputChatBox ( "A vehicle with an ID of " .. carid .. " was created!" )
	end
	-- If the entered car name returns no car ID, the string will be empty and false will be returned.
	-- If the string does have any value, we create the car and announce the car ID in the chatbox,
	-- because a car did exist under the given car name.
end
addCommandHandler ( "spawnvehicle", createvehiclecommand )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleIDFromName?oldid=16218"