Difference between revisions of "GetVehicleIDFromName"

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 27: Line 27:
 
--Get the position of the player to spawn the car near this location
 
--Get the position of the player to spawn the car near this location
 
if carid == false then
 
if carid == false then
outputChatBox ( "That is not a valid car name" )
+
outputChatBox ( "That is not a valid car name" )
 
else
 
else
createVehicle ( carid, x + 5, y, z )
+
createVehicle ( carid, x + 5, y, z )
--Spawn the car using it's ID. Spawn it at x + 5 from the player so it doesn't crush him
+
--Spawn the car using it's 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!" )
+
outputChatBox ( "A vehicle with an ID of "..carid.." was created!" )
 
end
 
end
 
--If the entered car name returns no car ID, the string will be empty and false will be returned.
 
--If the entered car name returns no car ID, the string will be empty and false will be returned.

Revision as of 19:01, 31 May 2007

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.

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.

addCommandHandler ( "spawnvehicle", "createvehiclecommand" )
function createvehiclecommand ( player, commandName, carname )
--This function is triggered by the text "spawnvehicle" in the console.
--The player must also specify the added varible carname to specify
--what car they wish to spawn.
carid = getVehicleIDFromName ( carname )
--Get the ID of the car the player asked for and store it to the
--varible 'carid'
local x, y, z = getElementPosition ( player )
--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 it's 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

See Also